openapi: 3.0.2 info: title: Pipeliner Cloud API description: >- Pipeliner has revolutionized the complexity of CRM with a simple, unique visual interface, a no-code workflow automation engine, and instant, dynamic insights and reporting. There is no other CRM that provides sales reps and sales management with so many ways to view and analyze sales data, while delivering intelligent, system-generated insights. Plus, thanks to our automation engine and easy integration with other systems (such as email, ERP, marketing), Pipeliner eliminates many of the manual and routine tasks that other systems impose on both sales reps and sales managers. The Pipeliner CRM experience is so different from traditional CRM, which is why we drive the highest adoption rates, lower total cost of ownership, and rapid return on investment. Plus, with our quick onboarding and ease of learning to use and/or administer the system, there is little to no business disruption during deployment. And because we are committed to supporting the professional development of salespeople, we have even integrated our online sales magazine Sales POP! into the product to provide unparalleled sales-related content at the point of impact. version: v100 x-api-status-urls: false 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: Lead & Opportunity - name: Contact - name: Activity - name: Account - name: Quote - name: Email - name: MasterRight - name: Project - name: Product - name: Online - name: Document - name: Client - name: Approval - name: Email Sequence - name: Process - name: Currency - name: Form - name: Message - name: Step - name: Text - name: Custom Entity - name: Report - name: Data - name: Field - name: Memo - name: Opportunity - name: Tag - name: Target - name: Webhook - name: SalesUnit - name: Call - name: Forecast - name: Import - name: Interface - name: Lead - name: Note - name: Phone - name: Pipeline - name: Product Line Items - name: SalesRole - name: Translation - name: Unsubscribed - name: Webresource - name: Profile - name: Api - name: Company Email - name: Timeframe - name: Type paths: /entities/Accounts/{id}: get: tags: - Account summary: Accounts.get operationId: Account_getById description: Returns Account with given id parameters: - description: ID of Account to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Account data content: application/json: schema: $ref: '#/components/schemas/AccountGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wr6mbpoyi8bdh delete: tags: - Account summary: Accounts.delete operationId: Account_removeById description: Removes Account with given id parameters: - description: ID of Account to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Account 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nz2drdvv2f78v patch: tags: - Account summary: Accounts.update operationId: Account_modifyById description: Modifies Account or Accounts with given id(s) parameters: - description: ID of Account to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Account 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountInput' responses: '200': description: Modification confirmation. Returns resulting Account content: application/json: schema: $ref: '#/components/schemas/AccountModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5rwgyblstp0tm /entities/Accounts: get: tags: - Account summary: Accounts.list operationId: Account_getAll description: Returns all defined Accounts parameters: - description: if enabled, deleted Accounts are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Accounts content: application/json: schema: $ref: '#/components/schemas/AccountGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sz16y5kpkxzwh post: tags: - Account summary: Accounts.create operationId: Account_addNewAccount description: Creates new Account parameters: - description: >- Specify validation level of Account 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Account required: true content: application / json: schema: $ref: '#/components/schemas/createAccountInput' responses: '201': description: Creation confirmation. Returns created Account content: application/json: schema: $ref: '#/components/schemas/AccountAddNewAccountResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0ua4kfatrxwsw /entities/Accounts/merge: post: tags: - Account summary: Accounts.merge operationId: Account_mergeAccounts description: Merger multiple Accounts into master record. parameters: [] requestBody: description: Entity . required: true content: application/json: schema: $ref: '#/components/schemas/AccountMergeAccountsRequest' responses: '200': description: Merged entity content: application/json: schema: $ref: '#/components/schemas/AccountMergeAccountsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 59iovx45f1iz5 /entities/Accounts/batch-delete: post: tags: - Account summary: Accounts.batch_delete operationId: Account_removeBatch description: Removes Accounts with given list of ids parameters: - description: >- Specify validation level of Accounts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aajrtjjrkrk7b /entities/Accounts/batch-modify: post: tags: - Account summary: Accounts.batch_create_or_update operationId: Account_batchCreateOrUpdate description: Create or update an batch of Accounts parameters: - description: >- Specify validation level of Accounts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Account required: true content: application / json: schema: $ref: '#/components/schemas/AccountBatchCreateOrUpdateRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Accounts content: application/json: schema: $ref: '#/components/schemas/AccountBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rwrzy1ufqwr2p /entities/AccountDataExRelations/{id}: get: tags: - Account summary: AccountDataExRelations.get operationId: Account_getById description: Returns AccountDataExRelation with given id parameters: - description: ID of AccountDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountDataExRelation data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2ectjtesibghd /entities/AccountDataExRelations: get: tags: - Account summary: AccountDataExRelations.list operationId: Account_getAllRelations description: Returns all defined AccountDataExRelations parameters: - description: if enabled, deleted AccountDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountDataExRelations content: application/json: schema: $ref: '#/components/schemas/AccountGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v757re5scn2we /entities/AccountKPIs/{id}: get: tags: - Account summary: AccountKPIs.get operationId: Account_getKpiById description: Returns AccountKPI with given id parameters: - description: ID of AccountKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountKPI data content: application/json: schema: $ref: '#/components/schemas/AccountGetKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0x5r7902uw8wn delete: tags: - Account summary: AccountKPIs.delete operationId: Account_removeById description: Removes AccountKPI with given id parameters: - description: ID of AccountKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountKPI 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eq3lx328y20qf patch: tags: - Account summary: AccountKPIs.update operationId: Account_modifyKPIById description: Modifies AccountKPI or AccountKPIs with given id(s) parameters: - description: ID of AccountKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountKPIInput' responses: '200': description: Modification confirmation. Returns resulting AccountKPI content: application/json: schema: $ref: '#/components/schemas/AccountModifyKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nijrv71fk21mb /entities/AccountKPIs: get: tags: - Account summary: AccountKPIs.list operationId: Account_getAllKpis description: Returns all defined AccountKPIs parameters: - description: if enabled, deleted AccountKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountKPIs content: application/json: schema: $ref: '#/components/schemas/AccountGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yzpaorp5kto8r post: tags: - Account summary: AccountKPIs.create operationId: Account_createNewKPI description: Creates new AccountKPI parameters: - description: >- Specify validation level of AccountKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountKPI required: true content: application / json: schema: $ref: '#/components/schemas/createAccountKPIInput' responses: '201': description: Creation confirmation. Returns created AccountKPI content: application/json: schema: $ref: '#/components/schemas/AccountCreateNewKpiResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ttjnsvonl3qjb /entities/AccountKPIs/batch-delete: post: tags: - Account summary: AccountKPIs.batch_delete operationId: Account_removeBatchKPIs description: Removes AccountKPIs with given list of ids parameters: - description: >- Specify validation level of AccountKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchKpIsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchKpIsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c132r3fpavaa6 /entities/AccountKPIs/batch-modify: post: tags: - Account summary: AccountKPIs.batch_create_or_update operationId: Account_modifyBatchAccountKPIs description: Create or update an batch of AccountKPIs parameters: - description: >- Specify validation level of AccountKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountKPI required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyBatchAccountKpIsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountKPIs content: application/json: schema: $ref: '#/components/schemas/AccountModifyBatchAccountKpIsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m1zq6v6aksua3 /entities/AccountRelations/{id}: get: tags: - Account summary: AccountRelations.get operationId: Account_getById description: Returns AccountRelation with given id parameters: - description: ID of AccountRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountRelation data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ej0macupjdmp2 delete: tags: - Account summary: AccountRelations.delete operationId: Account_removeById description: Removes AccountRelation with given id parameters: - description: ID of AccountRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hiuj5khsyhm35 patch: tags: - Account summary: AccountRelations.update operationId: Account_modifyRelation description: Modifies AccountRelation or AccountRelations with given id(s) parameters: - description: ID of AccountRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelation content: application/json: schema: $ref: '#/components/schemas/AccountModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: arjesalal31xr /entities/AccountRelations: get: tags: - Account summary: AccountRelations.list operationId: Account_getAllAccountRelations description: Returns all defined AccountRelations parameters: - description: if enabled, deleted AccountRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelations content: application/json: schema: $ref: '#/components/schemas/AccountGetAllAccountRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4pfkexuvzkdqh post: tags: - Account summary: AccountRelations.create operationId: Account_createNewRelation description: Creates new AccountRelation parameters: - description: >- Specify validation level of AccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationInput' responses: '201': description: Creation confirmation. Returns created AccountRelation content: application/json: schema: $ref: '#/components/schemas/AccountCreateNewRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mq7q0wnedikcy /entities/AccountRelations/batch-delete: post: tags: - Account summary: AccountRelations.batch_delete operationId: Account_removeBatchRelations description: Removes AccountRelations with given list of ids parameters: - description: >- Specify validation level of AccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nee745ivdjg8s /entities/AccountRelations/batch-modify: post: tags: - Account summary: AccountRelations.batch_create_or_update operationId: Account_modifyBatchRelations description: Create or update an batch of AccountRelations parameters: - description: >- Specify validation level of AccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountRelations content: application/json: schema: $ref: '#/components/schemas/AccountModifyBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s56gghc5xge78 /entities/AccountRelationLabels/{id}: get: tags: - Account summary: AccountRelationLabels.get operationId: Account_getById description: Returns AccountRelationLabel with given id parameters: - description: ID of AccountRelationLabel to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountRelationLabel data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5pmb0ebjwi7co delete: tags: - Account summary: AccountRelationLabels.delete operationId: Account_removeById description: Removes AccountRelationLabel with given id parameters: - description: ID of AccountRelationLabel to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vp08szoxq5ulc patch: tags: - Account summary: AccountRelationLabels.update operationId: Account_modifyLabel description: Modifies AccountRelationLabel or AccountRelationLabels with given id(s) parameters: - description: ID of AccountRelationLabel to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationLabelInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelationLabel content: application/json: schema: $ref: '#/components/schemas/AccountModifyLabelResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w5d5vf4b47zw0 /entities/AccountRelationLabels: get: tags: - Account summary: AccountRelationLabels.list operationId: Account_getAllLabels description: Returns all defined AccountRelationLabels parameters: - description: if enabled, deleted AccountRelationLabels are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelationLabels content: application/json: schema: $ref: '#/components/schemas/AccountGetAllLabelsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pzmv40xm4pu7f post: tags: - Account summary: AccountRelationLabels.create operationId: Account_createLabel description: Creates new AccountRelationLabel parameters: - description: >- Specify validation level of AccountRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationLabelInput' responses: '201': description: Creation confirmation. Returns created AccountRelationLabel content: application/json: schema: $ref: '#/components/schemas/AccountCreateLabelResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jrttae7zsemyt /entities/AccountRelationLabels/batch-delete: post: tags: - Account summary: AccountRelationLabels.batch_delete operationId: Account_removeBatchLabels description: Removes AccountRelationLabels with given list of ids parameters: - description: >- Specify validation level of AccountRelationLabels 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchLabelsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchLabelsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 96f0canthkulk /entities/AccountRelationLabels/batch-modify: post: tags: - Account summary: AccountRelationLabels.batch_create_or_update operationId: Account_modifyRelationLabelsBatch description: Create or update an batch of AccountRelationLabels parameters: - description: >- Specify validation level of AccountRelationLabels 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyRelationLabelsBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountRelationLabels content: application/json: schema: $ref: '#/components/schemas/AccountModifyRelationLabelsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8xpd7d7qkttij /entities/AccountRelationTypes/{id}: get: tags: - Account summary: AccountRelationTypes.get operationId: Account_getById description: Returns AccountRelationType with given id parameters: - description: ID of AccountRelationType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountRelationType data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dugcf8s0k0hrm delete: tags: - Account summary: AccountRelationTypes.delete operationId: Account_removeById description: Removes AccountRelationType with given id parameters: - description: ID of AccountRelationType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wg9ljjc6rmhlk patch: tags: - Account summary: AccountRelationTypes.update operationId: Account_modifyRelationType description: Modifies AccountRelationType or AccountRelationTypes with given id(s) parameters: - description: ID of AccountRelationType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelationType content: application/json: schema: $ref: '#/components/schemas/AccountModifyRelationTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yhjl59n5ga4nk /entities/AccountRelationTypes: get: tags: - Account summary: AccountRelationTypes.list operationId: Account_getAllTypes description: Returns all defined AccountRelationTypes parameters: - description: if enabled, deleted AccountRelationTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelationTypes content: application/json: schema: $ref: '#/components/schemas/AccountGetAllTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gfh0030ftpooy post: tags: - Account summary: AccountRelationTypes.create operationId: Account_createNewAccountRelationType description: Creates new AccountRelationType parameters: - description: >- Specify validation level of AccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationTypeInput' responses: '201': description: Creation confirmation. Returns created AccountRelationType content: application/json: schema: $ref: >- #/components/schemas/AccountCreateNewAccountRelationTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mclbwd22aqe7o /entities/AccountRelationTypes/batch-delete: post: tags: - Account summary: AccountRelationTypes.batch_delete operationId: Account_removeBatchByIds description: Removes AccountRelationTypes with given list of ids parameters: - description: >- Specify validation level of AccountRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gmoxxvt5nun5y /entities/AccountRelationTypes/batch-modify: post: tags: - Account summary: AccountRelationTypes.batch_create_or_update operationId: Account_modifyBatchAccountRelationTypes description: Create or update an batch of AccountRelationTypes parameters: - description: >- Specify validation level of AccountRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountRelationType required: true content: application / json: schema: $ref: >- #/components/schemas/AccountModifyBatchAccountRelationTypesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountRelationTypes content: application/json: schema: $ref: >- #/components/schemas/AccountModifyBatchAccountRelationTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 86ao7xhvf5rad /entities/AccountRoles/{id}: get: tags: - Account summary: AccountRoles.get operationId: Account_getById description: Returns AccountRole with given id parameters: - description: ID of AccountRole to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountRole data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mx718pwjvy064 delete: tags: - Account summary: AccountRoles.delete operationId: Account_removeById description: Removes AccountRole with given id parameters: - description: ID of AccountRole to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRole 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: svco2w2uy8uyv patch: tags: - Account summary: AccountRoles.update operationId: Account_modifyRole description: Modifies AccountRole or AccountRoles with given id(s) parameters: - description: ID of AccountRole to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountRole 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRoleInput' responses: '200': description: Modification confirmation. Returns resulting AccountRole content: application/json: schema: $ref: '#/components/schemas/AccountModifyRoleResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3rj82qjthlyi5 /entities/AccountRoles: get: tags: - Account summary: AccountRoles.list operationId: Account_getAllRoles description: Returns all defined AccountRoles parameters: - description: if enabled, deleted AccountRoles are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRoles content: application/json: schema: $ref: '#/components/schemas/AccountGetAllRolesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bo1dnsjpmbgzj post: tags: - Account summary: AccountRoles.create operationId: Account_createRole description: Creates new AccountRole parameters: - description: >- Specify validation level of AccountRole 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountRole required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRoleInput' responses: '201': description: Creation confirmation. Returns created AccountRole content: application/json: schema: $ref: '#/components/schemas/AccountCreateRoleResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vawjos8oijz40 /entities/AccountRoles/batch-delete: post: tags: - Account summary: AccountRoles.batch_delete operationId: Account_removeBatchAccountRoles description: Removes AccountRoles with given list of ids parameters: - description: >- Specify validation level of AccountRoles 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchAccountRolesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchAccountRolesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hn246ig1jv8pu /entities/AccountRoles/batch-modify: post: tags: - Account summary: AccountRoles.batch_create_or_update operationId: Account_modifyBatchRoles description: Create or update an batch of AccountRoles parameters: - description: >- Specify validation level of AccountRoles 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountRole required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyBatchRolesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountRoles content: application/json: schema: $ref: '#/components/schemas/AccountModifyBatchRolesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2zhv3qpn67pim /entities/AccountSharingClientRelations/{id}: get: tags: - Account summary: AccountSharingClientRelations.get operationId: Account_getById description: Returns AccountSharingClientRelation with given id parameters: - description: ID of AccountSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8c4hhdoy2o9qp delete: tags: - Account summary: AccountSharingClientRelations.delete operationId: Account_removeById description: Removes AccountSharingClientRelation with given id parameters: - description: ID of AccountSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7nan9o0xvyqje patch: tags: - Account summary: AccountSharingClientRelations.update operationId: Account_modifyRelation description: >- Modifies AccountSharingClientRelation or AccountSharingClientRelations with given id(s) parameters: - description: ID of AccountSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting AccountSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/AccountModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: apxcxnjrzdfxk /entities/AccountSharingClientRelations: get: tags: - Account summary: AccountSharingClientRelations.list operationId: Account_getAllClientRelations description: Returns all defined AccountSharingClientRelations parameters: - description: >- if enabled, deleted AccountSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/AccountGetAllClientRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4qrupxm8whm99 post: tags: - Account summary: AccountSharingClientRelations.create operationId: Account_createNewRelation description: Creates new AccountSharingClientRelation parameters: - description: >- Specify validation level of AccountSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created AccountSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/AccountCreateNewRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sh3to4cp5x6n4 /entities/AccountSharingClientRelations/batch-delete: post: tags: - Account summary: AccountSharingClientRelations.batch_delete operationId: Account_removeBatch description: Removes AccountSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of AccountSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ydmc5cx7g7mjh /entities/AccountSharingClientRelations/batch-modify: post: tags: - Account summary: AccountSharingClientRelations.batch_create_or_update operationId: Account_modifyBatchAccountSharingClientRelations description: Create or update an batch of AccountSharingClientRelations parameters: - description: >- Specify validation level of AccountSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountSharingClientRelation required: true content: application / json: schema: $ref: >- #/components/schemas/AccountModifyBatchAccountSharingClientRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/AccountModifyBatchAccountSharingClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jbmpgv2hp27v2 /entities/AccountSharingSalesUnitRelations/{id}: get: tags: - Account summary: AccountSharingSalesUnitRelations.get operationId: Account_getById description: Returns AccountSharingSalesUnitRelation with given id parameters: - description: ID of AccountSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 17dhmtkt6g3hd delete: tags: - Account summary: AccountSharingSalesUnitRelations.delete operationId: Account_removeById description: Removes AccountSharingSalesUnitRelation with given id parameters: - description: ID of AccountSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nscrgnv0vayzy patch: tags: - Account summary: AccountSharingSalesUnitRelations.update operationId: Account_updateRelation description: >- Modifies AccountSharingSalesUnitRelation or AccountSharingSalesUnitRelations with given id(s) parameters: - description: ID of AccountSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting AccountSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f42q6cn5f5s58 /entities/AccountSharingSalesUnitRelations: get: tags: - Account summary: AccountSharingSalesUnitRelations.list operationId: Account_listRelations description: Returns all defined AccountSharingSalesUnitRelations parameters: - description: >- if enabled, deleted AccountSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/AccountListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2frvpkrd94d0r post: tags: - Account summary: AccountSharingSalesUnitRelations.create operationId: Account_createRelation description: Creates new AccountSharingSalesUnitRelation parameters: - description: >- Specify validation level of AccountSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSharingSalesUnitRelationInput' responses: '201': description: >- Creation confirmation. Returns created AccountSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/AccountCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e14ui3sx74tqi /entities/AccountSharingSalesUnitRelations/batch-delete: post: tags: - Account summary: AccountSharingSalesUnitRelations.batch_delete operationId: Account_removeBatchSalesUnitRelations description: Removes AccountSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of AccountSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchSalesUnitRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/AccountRemoveBatchSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rbzazx9up90rn /entities/AccountSharingSalesUnitRelations/batch-modify: post: tags: - Account summary: AccountSharingSalesUnitRelations.batch_create_or_update operationId: Account_updateBatch description: Create or update an batch of AccountSharingSalesUnitRelations parameters: - description: >- Specify validation level of AccountSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/AccountUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/AccountUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: olp3chpik26qe /entities/AccountSocialRelations/{id}: get: tags: - Account summary: AccountSocialRelations.get operationId: Account_getById description: Returns AccountSocialRelation with given id parameters: - description: ID of AccountSocialRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountSocialRelation data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vkgj2oegl8tki delete: tags: - Account summary: AccountSocialRelations.delete operationId: Account_removeById description: Removes AccountSocialRelation with given id parameters: - description: ID of AccountSocialRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kxabci7qfuhyh patch: tags: - Account summary: AccountSocialRelations.update operationId: Account_modifySocialRelation description: >- Modifies AccountSocialRelation or AccountSocialRelations with given id(s) parameters: - description: ID of AccountSocialRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSocialRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountSocialRelation content: application/json: schema: $ref: '#/components/schemas/AccountModifySocialRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zbr6fjul6y245 /entities/AccountSocialRelations: get: tags: - Account summary: AccountSocialRelations.list operationId: Account_getAllSocialRelations description: Returns all defined AccountSocialRelations parameters: - description: if enabled, deleted AccountSocialRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSocialRelations content: application/json: schema: $ref: '#/components/schemas/AccountGetAllSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4w6kfnd9dwswv post: tags: - Account summary: AccountSocialRelations.create operationId: Account_createNewSocialRelation description: Creates new AccountSocialRelation parameters: - description: >- Specify validation level of AccountSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSocialRelationInput' responses: '201': description: Creation confirmation. Returns created AccountSocialRelation content: application/json: schema: $ref: '#/components/schemas/AccountCreateNewSocialRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zmxy7ytra0t76 /entities/AccountSocialRelations/batch-delete: post: tags: - Account summary: AccountSocialRelations.batch_delete operationId: Account_removeBatchSocialRelations description: Removes AccountSocialRelations with given list of ids parameters: - description: >- Specify validation level of AccountSocialRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchSocialRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wbbhcxvsdclgb /entities/AccountSocialRelations/batch-modify: post: tags: - Account summary: AccountSocialRelations.batch_create_or_update operationId: Account_modifyBatchSocialRelations description: Create or update an batch of AccountSocialRelations parameters: - description: >- Specify validation level of AccountSocialRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyBatchSocialRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountSocialRelations content: application/json: schema: $ref: '#/components/schemas/AccountModifyBatchSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lgu4mo4lh5mvu /entities/AccountTypes/{id}: get: tags: - Account summary: AccountTypes.get operationId: Account_getTypeById description: Returns AccountType with given id parameters: - description: ID of AccountType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AccountType data content: application/json: schema: $ref: '#/components/schemas/AccountGetTypeByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pt691b1j67b21 delete: tags: - Account summary: AccountTypes.delete operationId: Account_removeById description: Removes AccountType with given id parameters: - description: ID of AccountType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q0vqimdl8mkr5 patch: tags: - Account summary: AccountTypes.update operationId: Account_updateAccountType description: Modifies AccountType or AccountTypes with given id(s) parameters: - description: ID of AccountType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AccountType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountTypeInput' responses: '200': description: Modification confirmation. Returns resulting AccountType content: application/json: schema: $ref: '#/components/schemas/AccountUpdateAccountTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4svjld84ki44l /entities/AccountTypes: get: tags: - Account summary: AccountTypes.list operationId: Account_getAllAccountTypes description: Returns all defined AccountTypes parameters: - description: if enabled, deleted AccountTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountTypes content: application/json: schema: $ref: '#/components/schemas/AccountGetAllAccountTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7tcyi6l31qnz2 post: tags: - Account summary: AccountTypes.create operationId: Account_createNewType description: Creates new AccountType parameters: - description: >- Specify validation level of AccountType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AccountType required: true content: application / json: schema: $ref: '#/components/schemas/createAccountTypeInput' responses: '201': description: Creation confirmation. Returns created AccountType content: application/json: schema: $ref: '#/components/schemas/AccountCreateNewTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 50etd03wekngm /entities/AccountTypes/batch-delete: post: tags: - Account summary: AccountTypes.batch_delete operationId: Account_removeBatchAccountTypes description: Removes AccountTypes with given list of ids parameters: - description: >- Specify validation level of AccountTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchAccountTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchAccountTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 77gspdlzvbobg /entities/AccountTypes/batch-modify: post: tags: - Account summary: AccountTypes.batch_create_or_update operationId: Account_modifyBatchAccountTypes description: Create or update an batch of AccountTypes parameters: - description: >- Specify validation level of AccountTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AccountType required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyBatchAccountTypesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AccountTypes content: application/json: schema: $ref: '#/components/schemas/AccountModifyBatchAccountTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p7lf7b0td6lma /entities/Activities/{id}: get: tags: - Activity summary: Activities.get operationId: Activity_getById description: Returns Activity with given id parameters: - description: ID of Activity to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Activity data content: application/json: schema: $ref: '#/components/schemas/ActivityGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7ianwd1hsaz9x /entities/Activities: get: tags: - Activity summary: Activities.list operationId: Activity_getAllActivities description: Returns all defined Activities parameters: - description: if enabled, deleted Activities are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Activities content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllActivitiesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m79uazuq0hygt /entities/ActivityComments/{id}: get: tags: - Activity summary: ActivityComments.get operationId: Activity_getById description: Returns ActivityComment with given id parameters: - description: ID of ActivityComment to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ActivityComment data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d1toz7k8i0bhf delete: tags: - Activity summary: ActivityComments.delete operationId: Activity_removeById description: Removes ActivityComment with given id parameters: - description: ID of ActivityComment to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityComment on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oqmhj7tro1x3p patch: tags: - Activity summary: ActivityComments.update operationId: Activity_modifyById description: Modifies ActivityComment or ActivityComments with given id(s) parameters: - description: ID of ActivityComment to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityComment on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateActivityCommentInput' responses: '200': description: Modification confirmation. Returns resulting ActivityComment content: application/json: schema: $ref: '#/components/schemas/ActivityModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 05vevfowc1sot /entities/ActivityComments: get: tags: - Activity summary: ActivityComments.list operationId: Activity_getAllActivityComments description: Returns all defined ActivityComments parameters: - description: if enabled, deleted ActivityComments are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ActivityComments content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllActivityCommentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qor7cy9iz9a8y post: tags: - Activity summary: ActivityComments.create operationId: Activity_createNewActivityComment description: Creates new ActivityComment parameters: - description: >- Specify validation level of ActivityComment on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ActivityComment required: true content: application / json: schema: $ref: '#/components/schemas/createActivityCommentInput' responses: '201': description: Creation confirmation. Returns created ActivityComment content: application/json: schema: $ref: '#/components/schemas/ActivityCreateNewActivityCommentResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b8q5bw9l4vucq /entities/ActivityComments/batch-delete: post: tags: - Activity summary: ActivityComments.batch_delete operationId: Activity_removeBatch description: Removes ActivityComments with given list of ids parameters: - description: >- Specify validation level of ActivityComments on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityComments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kzxsyoicah1wz /entities/ActivityComments/batch-modify: post: tags: - Activity summary: ActivityComments.batch_create_or_update operationId: Activity_modifyBatchComments description: Create or update an batch of ActivityComments parameters: - description: >- Specify validation level of ActivityComments on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityComments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ActivityComment required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyBatchCommentsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ActivityComments content: application/json: schema: $ref: '#/components/schemas/ActivityModifyBatchCommentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o86ni5xcctbut /entities/ActivityDataExRelations/{id}: get: tags: - Activity summary: ActivityDataExRelations.get operationId: Activity_getById description: Returns ActivityDataExRelation with given id parameters: - description: ID of ActivityDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ActivityDataExRelation data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ki71n8rbghzb5 /entities/ActivityDataExRelations: get: tags: - Activity summary: ActivityDataExRelations.list operationId: Activity_getAllRelations description: Returns all defined ActivityDataExRelations parameters: - description: if enabled, deleted ActivityDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ActivityDataExRelations content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c59x37q1ug5jj /entities/ActivityKPIs/{id}: get: tags: - Activity summary: ActivityKPIs.get operationId: Activity_getById description: Returns ActivityKPI with given id parameters: - description: ID of ActivityKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ActivityKPI data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cvxt6opjvvj4u delete: tags: - Activity summary: ActivityKPIs.delete operationId: Activity_removeById description: Removes ActivityKPI with given id parameters: - description: ID of ActivityKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityKPI on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4vidve5xo7gdd patch: tags: - Activity summary: ActivityKPIs.update operationId: Activity_modifyKPIById description: Modifies ActivityKPI or ActivityKPIs with given id(s) parameters: - description: ID of ActivityKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityKPI on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateActivityKPIInput' responses: '200': description: Modification confirmation. Returns resulting ActivityKPI content: application/json: schema: $ref: '#/components/schemas/ActivityModifyKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i0bq46nyort6e /entities/ActivityKPIs: get: tags: - Activity summary: ActivityKPIs.list operationId: Activity_getAllKpis description: Returns all defined ActivityKPIs parameters: - description: if enabled, deleted ActivityKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ActivityKPIs content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sesnjvuws3ivt post: tags: - Activity summary: ActivityKPIs.create operationId: Activity_createNewKPI description: Creates new ActivityKPI parameters: - description: >- Specify validation level of ActivityKPI on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ActivityKPI required: true content: application / json: schema: $ref: '#/components/schemas/createActivityKPIInput' responses: '201': description: Creation confirmation. Returns created ActivityKPI content: application/json: schema: $ref: '#/components/schemas/ActivityCreateNewKpiResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vzi4re2mxi4xm /entities/ActivityKPIs/batch-delete: post: tags: - Activity summary: ActivityKPIs.batch_delete operationId: Activity_removeBatch description: Removes ActivityKPIs with given list of ids parameters: - description: >- Specify validation level of ActivityKPIs on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vzxe71p8jvmus /entities/ActivityKPIs/batch-modify: post: tags: - Activity summary: ActivityKPIs.batch_create_or_update operationId: Activity_createOrUpdateBatch description: Create or update an batch of ActivityKPIs parameters: - description: >- Specify validation level of ActivityKPIs on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ActivityKPI required: true content: application / json: schema: $ref: '#/components/schemas/ActivityCreateOrUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ActivityKPIs content: application/json: schema: $ref: '#/components/schemas/ActivityCreateOrUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d5f8tt0elk496 /entities/ActivityRelations/{id}: get: tags: - Activity summary: ActivityRelations.get operationId: Activity_getById description: Returns ActivityRelation with given id parameters: - description: ID of ActivityRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ActivityRelation data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g7pfuuypa3tok delete: tags: - Activity summary: ActivityRelations.delete operationId: Activity_removeById description: Removes ActivityRelation with given id parameters: - description: ID of ActivityRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: awivfxvp6lb2l patch: tags: - Activity summary: ActivityRelations.update operationId: Activity_modifyRelation description: Modifies ActivityRelation or ActivityRelations with given id(s) parameters: - description: ID of ActivityRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ActivityRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateActivityRelationInput' responses: '200': description: Modification confirmation. Returns resulting ActivityRelation content: application/json: schema: $ref: '#/components/schemas/ActivityModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f7uo6d7dgfkj0 /entities/ActivityRelations: get: tags: - Activity summary: ActivityRelations.list operationId: Activity_getAllActivityRelations description: Returns all defined ActivityRelations parameters: - description: if enabled, deleted ActivityRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ActivityRelations content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllActivityRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xov7yv5kppwwi post: tags: - Activity summary: ActivityRelations.create operationId: Activity_createNewActivityRelation description: Creates new ActivityRelation parameters: - description: >- Specify validation level of ActivityRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ActivityRelation required: true content: application / json: schema: $ref: '#/components/schemas/createActivityRelationInput' responses: '201': description: Creation confirmation. Returns created ActivityRelation content: application/json: schema: $ref: '#/components/schemas/ActivityCreateNewActivityRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uco3z2xn0l69m /entities/ActivityRelations/batch-delete: post: tags: - Activity summary: ActivityRelations.batch_delete operationId: Activity_removeBatchActivityRelations description: Removes ActivityRelations with given list of ids parameters: - description: >- Specify validation level of ActivityRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchActivityRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ActivityRemoveBatchActivityRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 29sgfmpfl3937 /entities/ActivityRelations/batch-modify: post: tags: - Activity summary: ActivityRelations.batch_create_or_update operationId: Activity_modifyBatchRelations description: Create or update an batch of ActivityRelations parameters: - description: >- Specify validation level of ActivityRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ActivityRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ActivityRelation required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ActivityRelations content: application/json: schema: $ref: '#/components/schemas/ActivityModifyBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lpmvpthgg4vzu /entities/AllowedAccountTypes/{id}: get: tags: - MasterRight summary: AllowedAccountTypes.get operationId: MasterRight_getAllowedAccountTypeById description: Returns AllowedAccountType with given id parameters: - description: ID of AllowedAccountType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedAccountType data content: application/json: schema: $ref: >- #/components/schemas/MasterRightGetAllowedAccountTypeByIdResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a1e80h0tl1gxo delete: tags: - MasterRight summary: AllowedAccountTypes.delete operationId: MasterRight_removeById description: Removes AllowedAccountType with given id parameters: - description: ID of AllowedAccountType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedAccountType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y9j8cv33tfwxs patch: tags: - MasterRight summary: AllowedAccountTypes.update operationId: MasterRight_modifyAllowedAccountType description: Modifies AllowedAccountType or AllowedAccountTypes with given id(s) parameters: - description: ID of AllowedAccountType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedAccountType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedAccountTypeInput' responses: '200': description: Modification confirmation. Returns resulting AllowedAccountType content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedAccountTypeResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2uqw29v23a064 /entities/AllowedAccountTypes: get: tags: - MasterRight summary: AllowedAccountTypes.list operationId: MasterRight_getAllowedAccountTypes description: Returns all defined AllowedAccountTypes parameters: - description: if enabled, deleted AllowedAccountTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedAccountTypes content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedAccountTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a4s1kxp5g8xz4 post: tags: - MasterRight summary: AllowedAccountTypes.create operationId: MasterRight_createAllowedAccountType description: Creates new AllowedAccountType parameters: - description: >- Specify validation level of AllowedAccountType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedAccountType required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedAccountTypeInput' responses: '201': description: Creation confirmation. Returns created AllowedAccountType content: application/json: schema: $ref: >- #/components/schemas/MasterRightCreateAllowedAccountTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bu86d8oqszblk /entities/AllowedAccountTypes/batch-delete: post: tags: - MasterRight summary: AllowedAccountTypes.batch_delete operationId: MasterRight_removeAllowedAccountTypes description: Removes AllowedAccountTypes with given list of ids parameters: - description: >- Specify validation level of AllowedAccountTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedAccountTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveAllowedAccountTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bgzo9lh7mzip1 /entities/AllowedAccountTypes/batch-modify: post: tags: - MasterRight summary: AllowedAccountTypes.batch_create_or_update operationId: MasterRight_modifyAllowedAccountTypesBatch description: Create or update an batch of AllowedAccountTypes parameters: - description: >- Specify validation level of AllowedAccountTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedAccountType required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedAccountTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedAccountTypes content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedAccountTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eva3pq5d0fjzv /entities/AllowedCompanyEmails/{id}: get: tags: - MasterRight summary: AllowedCompanyEmails.get operationId: MasterRight_getAllowedCompanyEmail description: Returns AllowedCompanyEmail with given id parameters: - description: ID of AllowedCompanyEmail to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedCompanyEmail data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedCompanyEmailResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: emual7ki74qxd delete: tags: - MasterRight summary: AllowedCompanyEmails.delete operationId: MasterRight_removeById description: Removes AllowedCompanyEmail with given id parameters: - description: ID of AllowedCompanyEmail to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedCompanyEmail 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 26vb6rwqbengb patch: tags: - MasterRight summary: AllowedCompanyEmails.update operationId: MasterRight_updateAllowedCompanyEmail description: Modifies AllowedCompanyEmail or AllowedCompanyEmails with given id(s) parameters: - description: ID of AllowedCompanyEmail to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedCompanyEmail 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedCompanyEmailInput' responses: '200': description: Modification confirmation. Returns resulting AllowedCompanyEmail content: application/json: schema: $ref: >- #/components/schemas/MasterRightUpdateAllowedCompanyEmailResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fdogr3hix9khk /entities/AllowedCompanyEmails: get: tags: - MasterRight summary: AllowedCompanyEmails.list operationId: MasterRight_getAllAllowedCompanyEmails description: Returns all defined AllowedCompanyEmails parameters: - description: if enabled, deleted AllowedCompanyEmails are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedCompanyEmails content: application/json: schema: $ref: >- #/components/schemas/MasterRightGetAllAllowedCompanyEmailsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kkx9psdlvknfd post: tags: - MasterRight summary: AllowedCompanyEmails.create operationId: MasterRight_createAllowedCompanyEmail description: Creates new AllowedCompanyEmail parameters: - description: >- Specify validation level of AllowedCompanyEmail 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedCompanyEmail required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedCompanyEmailInput' responses: '201': description: Creation confirmation. Returns created AllowedCompanyEmail content: application/json: schema: $ref: >- #/components/schemas/MasterRightCreateAllowedCompanyEmailResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dhsubae3dvu3f /entities/AllowedCompanyEmails/batch-delete: post: tags: - MasterRight summary: AllowedCompanyEmails.batch_delete operationId: MasterRight_removeBatchAllowedCompanyEmails description: Removes AllowedCompanyEmails with given list of ids parameters: - description: >- Specify validation level of AllowedCompanyEmails 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedCompanyEmailsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedCompanyEmailsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vozagvizazcm8 /entities/AllowedCompanyEmails/batch-modify: post: tags: - MasterRight summary: AllowedCompanyEmails.batch_create_or_update operationId: MasterRight_modifyAllowedCompanyEmailsBatch description: Create or update an batch of AllowedCompanyEmails parameters: - description: >- Specify validation level of AllowedCompanyEmails 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedCompanyEmail required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedCompanyEmailsBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedCompanyEmails content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedCompanyEmailsBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lc30vqgzys98f /entities/AllowedCompanyPhones/{id}: get: tags: - MasterRight summary: AllowedCompanyPhones.get operationId: MasterRight_getAllowedCompanyPhone description: Returns AllowedCompanyPhone with given id parameters: - description: ID of AllowedCompanyPhone to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedCompanyPhone data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedCompanyPhoneResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iaf8hxaems8o8 delete: tags: - MasterRight summary: AllowedCompanyPhones.delete operationId: MasterRight_removeById description: Removes AllowedCompanyPhone with given id parameters: - description: ID of AllowedCompanyPhone to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedCompanyPhone 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: at54kkxqqzlfb patch: tags: - MasterRight summary: AllowedCompanyPhones.update operationId: MasterRight_updateAllowedCompanyPhone description: Modifies AllowedCompanyPhone or AllowedCompanyPhones with given id(s) parameters: - description: ID of AllowedCompanyPhone to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedCompanyPhone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedCompanyPhoneInput' responses: '200': description: Modification confirmation. Returns resulting AllowedCompanyPhone content: application/json: schema: $ref: >- #/components/schemas/MasterRightUpdateAllowedCompanyPhoneResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sznbfh28o1qrv /entities/AllowedCompanyPhones: get: tags: - MasterRight summary: AllowedCompanyPhones.list operationId: MasterRight_getAllowedPhones description: Returns all defined AllowedCompanyPhones parameters: - description: if enabled, deleted AllowedCompanyPhones are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedCompanyPhones content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedPhonesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j85dpeb8y33m7 post: tags: - MasterRight summary: AllowedCompanyPhones.create operationId: MasterRight_createAllowedCompanyPhone description: Creates new AllowedCompanyPhone parameters: - description: >- Specify validation level of AllowedCompanyPhone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedCompanyPhone required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedCompanyPhoneInput' responses: '201': description: Creation confirmation. Returns created AllowedCompanyPhone content: application/json: schema: $ref: >- #/components/schemas/MasterRightCreateAllowedCompanyPhoneResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: llqq47wlqe24m /entities/AllowedCompanyPhones/batch-delete: post: tags: - MasterRight summary: AllowedCompanyPhones.batch_delete operationId: MasterRight_removeBatchAllowedCompanyPhones description: Removes AllowedCompanyPhones with given list of ids parameters: - description: >- Specify validation level of AllowedCompanyPhones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedCompanyPhonesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedCompanyPhonesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kamd8ufr5zb66 /entities/AllowedCompanyPhones/batch-modify: post: tags: - MasterRight summary: AllowedCompanyPhones.batch_create_or_update operationId: MasterRight_modifyAllowedCompanyPhonesBatch description: Create or update an batch of AllowedCompanyPhones parameters: - description: >- Specify validation level of AllowedCompanyPhones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedCompanyPhone required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedCompanyPhonesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedCompanyPhones content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedCompanyPhonesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6fs36bc4ntjn3 /entities/AllowedContactTypes/{id}: get: tags: - MasterRight summary: AllowedContactTypes.get operationId: MasterRight_getAllowedContactType description: Returns AllowedContactType with given id parameters: - description: ID of AllowedContactType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedContactType data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedContactTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2vu76co2xjuvk delete: tags: - MasterRight summary: AllowedContactTypes.delete operationId: MasterRight_removeAllowedContactType description: Removes AllowedContactType with given id parameters: - description: ID of AllowedContactType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedContactType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveAllowedContactTypeResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ydhr63bu1ik1 patch: tags: - MasterRight summary: AllowedContactTypes.update operationId: MasterRight_updateAllowedContactTypes description: Modifies AllowedContactType or AllowedContactTypes with given id(s) parameters: - description: ID of AllowedContactType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedContactType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedContactTypeInput' responses: '200': description: Modification confirmation. Returns resulting AllowedContactType content: application/json: schema: $ref: >- #/components/schemas/MasterRightUpdateAllowedContactTypesResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yx5y24vs7ah9f /entities/AllowedContactTypes: get: tags: - MasterRight summary: AllowedContactTypes.list operationId: MasterRight_getAllowedContactTypes description: Returns all defined AllowedContactTypes parameters: - description: if enabled, deleted AllowedContactTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedContactTypes content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedContactTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jrvzgux66j8uv post: tags: - MasterRight summary: AllowedContactTypes.create operationId: MasterRight_createAllowedContactType description: Creates new AllowedContactType parameters: - description: >- Specify validation level of AllowedContactType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedContactType required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedContactTypeInput' responses: '201': description: Creation confirmation. Returns created AllowedContactType content: application/json: schema: $ref: >- #/components/schemas/MasterRightCreateAllowedContactTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: li9bg2fg09h94 /entities/AllowedContactTypes/batch-delete: post: tags: - MasterRight summary: AllowedContactTypes.batch_delete operationId: MasterRight_removeAllowedContactTypes description: Removes AllowedContactTypes with given list of ids parameters: - description: >- Specify validation level of AllowedContactTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedContactTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveAllowedContactTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r22avps1s86gc /entities/AllowedContactTypes/batch-modify: post: tags: - MasterRight summary: AllowedContactTypes.batch_create_or_update operationId: MasterRight_modifyAllowedContactTypesBatch description: Create or update an batch of AllowedContactTypes parameters: - description: >- Specify validation level of AllowedContactTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedContactType required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedContactTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedContactTypes content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedContactTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: h3ui2yibfhqfw /entities/AllowedLeadTypes/{id}: get: tags: - MasterRight summary: AllowedLeadTypes.get operationId: MasterRight_getAllowedLeadType description: Returns AllowedLeadType with given id parameters: - description: ID of AllowedLeadType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedLeadType data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedLeadTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z7k64ciy4ursd delete: tags: - MasterRight summary: AllowedLeadTypes.delete operationId: MasterRight_removeAllowedLeadType description: Removes AllowedLeadType with given id parameters: - description: ID of AllowedLeadType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedLeadType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedLeadTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jsdcirgr6oseu patch: tags: - MasterRight summary: AllowedLeadTypes.update operationId: MasterRight_modifyAllowedLeadTypes description: Modifies AllowedLeadType or AllowedLeadTypes with given id(s) parameters: - description: ID of AllowedLeadType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedLeadType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedLeadTypeInput' responses: '200': description: Modification confirmation. Returns resulting AllowedLeadType content: application/json: schema: $ref: '#/components/schemas/MasterRightModifyAllowedLeadTypesResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3w7mafp7bk6kc /entities/AllowedLeadTypes: get: tags: - MasterRight summary: AllowedLeadTypes.list operationId: MasterRight_getAllowedLeadTypes description: Returns all defined AllowedLeadTypes parameters: - description: if enabled, deleted AllowedLeadTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedLeadTypes content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedLeadTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 23n79p2n3c4lc post: tags: - MasterRight summary: AllowedLeadTypes.create operationId: MasterRight_createAllowedLeadType description: Creates new AllowedLeadType parameters: - description: >- Specify validation level of AllowedLeadType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedLeadType required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedLeadTypeInput' responses: '201': description: Creation confirmation. Returns created AllowedLeadType content: application/json: schema: $ref: '#/components/schemas/MasterRightCreateAllowedLeadTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: poygdti3oq53o /entities/AllowedLeadTypes/batch-delete: post: tags: - MasterRight summary: AllowedLeadTypes.batch_delete operationId: MasterRight_removeAllowedLeadTypes description: Removes AllowedLeadTypes with given list of ids parameters: - description: >- Specify validation level of AllowedLeadTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedLeadTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedLeadTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 14b0pqsi116qp /entities/AllowedLeadTypes/batch-modify: post: tags: - MasterRight summary: AllowedLeadTypes.batch_create_or_update operationId: MasterRight_modifyAllowedLeadTypesBatch description: Create or update an batch of AllowedLeadTypes parameters: - description: >- Specify validation level of AllowedLeadTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedLeadType required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedLeadTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedLeadTypes content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedLeadTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kjfes58dafdhg /entities/AllowedPipelines/{id}: get: tags: - MasterRight summary: AllowedPipelines.get operationId: MasterRight_getAllowedPipeline description: Returns AllowedPipeline with given id parameters: - description: ID of AllowedPipeline to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedPipeline data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedPipelineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sp1rymnian3d2 delete: tags: - MasterRight summary: AllowedPipelines.delete operationId: MasterRight_removeAllowedPipeline description: Removes AllowedPipeline with given id parameters: - description: ID of AllowedPipeline to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedPipeline 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedPipelineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nqewnywv15pis patch: tags: - MasterRight summary: AllowedPipelines.update operationId: MasterRight_modifyAllowedPipeline description: Modifies AllowedPipeline or AllowedPipelines with given id(s) parameters: - description: ID of AllowedPipeline to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedPipeline 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedPipelineInput' responses: '200': description: Modification confirmation. Returns resulting AllowedPipeline content: application/json: schema: $ref: '#/components/schemas/MasterRightModifyAllowedPipelineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: my6ebt323fxux /entities/AllowedPipelines: get: tags: - MasterRight summary: AllowedPipelines.list operationId: MasterRight_getAllowedPipelines description: Returns all defined AllowedPipelines parameters: - description: if enabled, deleted AllowedPipelines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedPipelines content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedPipelinesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ubzl2pj3hdc9t post: tags: - MasterRight summary: AllowedPipelines.create operationId: MasterRight_createAllowedPipeline description: Creates new AllowedPipeline parameters: - description: >- Specify validation level of AllowedPipeline 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedPipeline required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedPipelineInput' responses: '201': description: Creation confirmation. Returns created AllowedPipeline content: application/json: schema: $ref: '#/components/schemas/MasterRightCreateAllowedPipelineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2rhdsqw80s9wj /entities/AllowedPipelines/batch-delete: post: tags: - MasterRight summary: AllowedPipelines.batch_delete operationId: MasterRight_removeBatchAllowedPipelines description: Removes AllowedPipelines with given list of ids parameters: - description: >- Specify validation level of AllowedPipelines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedPipelinesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveBatchAllowedPipelinesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pkfbrr9d7tyl1 /entities/AllowedPipelines/batch-modify: post: tags: - MasterRight summary: AllowedPipelines.batch_create_or_update operationId: MasterRight_batchModifyAllowedPipelines description: Create or update an batch of AllowedPipelines parameters: - description: >- Specify validation level of AllowedPipelines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedPipeline required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightBatchModifyAllowedPipelinesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedPipelines content: application/json: schema: $ref: >- #/components/schemas/MasterRightBatchModifyAllowedPipelinesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kohk0rsad2s4x /entities/AllowedQuoteTypes/{id}: get: tags: - MasterRight summary: AllowedQuoteTypes.get operationId: MasterRight_getAllowedQuoteType description: Returns AllowedQuoteType with given id parameters: - description: ID of AllowedQuoteType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AllowedQuoteType data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedQuoteTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r50mxel8k7gkk delete: tags: - MasterRight summary: AllowedQuoteTypes.delete operationId: MasterRight_removeById description: Removes AllowedQuoteType with given id parameters: - description: ID of AllowedQuoteType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedQuoteType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3lbtxwj59k18d patch: tags: - MasterRight summary: AllowedQuoteTypes.update operationId: MasterRight_updateAllowedQuoteType description: Modifies AllowedQuoteType or AllowedQuoteTypes with given id(s) parameters: - description: ID of AllowedQuoteType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AllowedQuoteType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAllowedQuoteTypeInput' responses: '200': description: Modification confirmation. Returns resulting AllowedQuoteType content: application/json: schema: $ref: '#/components/schemas/MasterRightUpdateAllowedQuoteTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6ig9usip9l04x /entities/AllowedQuoteTypes: get: tags: - MasterRight summary: AllowedQuoteTypes.list operationId: MasterRight_getAllowedQuoteTypes description: Returns all defined AllowedQuoteTypes parameters: - description: if enabled, deleted AllowedQuoteTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AllowedQuoteTypes content: application/json: schema: $ref: '#/components/schemas/MasterRightGetAllowedQuoteTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zp1i4ce9ecy7k post: tags: - MasterRight summary: AllowedQuoteTypes.create operationId: MasterRight_createAllowedQuoteType description: Creates new AllowedQuoteType parameters: - description: >- Specify validation level of AllowedQuoteType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AllowedQuoteType required: true content: application / json: schema: $ref: '#/components/schemas/createAllowedQuoteTypeInput' responses: '201': description: Creation confirmation. Returns created AllowedQuoteType content: application/json: schema: $ref: '#/components/schemas/MasterRightCreateAllowedQuoteTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i8enfr27a81x4 /entities/AllowedQuoteTypes/batch-delete: post: tags: - MasterRight summary: AllowedQuoteTypes.batch_delete operationId: MasterRight_removeAllowedQuoteTypes description: Removes AllowedQuoteTypes with given list of ids parameters: - description: >- Specify validation level of AllowedQuoteTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightRemoveAllowedQuoteTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MasterRightRemoveAllowedQuoteTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mcpm0i2jieyxd /entities/AllowedQuoteTypes/batch-modify: post: tags: - MasterRight summary: AllowedQuoteTypes.batch_create_or_update operationId: MasterRight_modifyAllowedQuoteTypesBatch description: Create or update an batch of AllowedQuoteTypes parameters: - description: >- Specify validation level of AllowedQuoteTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AllowedQuoteType required: true content: application / json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedQuoteTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AllowedQuoteTypes content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyAllowedQuoteTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ypn0znhlhc9dg /entities/ApiAccesses/{id}: get: tags: - Api summary: ApiAccesses.get operationId: Api_getById description: Returns ApiAccess with given id parameters: - description: ID of ApiAccess to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ApiAccess data content: application/json: schema: $ref: '#/components/schemas/ApiGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9rfi19skp39tw /entities/ApiAccesses: get: tags: - Api summary: ApiAccesses.list operationId: Api_accessesList description: Returns all defined ApiAccesses parameters: - description: if enabled, deleted ApiAccesses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ApiAccesses content: application/json: schema: $ref: '#/components/schemas/ApiAccessesListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d1quvdkyfdaed /entities/Appointments/{id}: get: tags: - Activity summary: Appointments.get operationId: Activity_getById description: Returns Appointment with given id parameters: - description: ID of Appointment to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Appointment data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u3s68cjz9zcfb delete: tags: - Activity summary: Appointments.delete operationId: Activity_removeById description: Removes Appointment with given id parameters: - description: ID of Appointment to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Appointment on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: huszd7nez98kd patch: tags: - Activity summary: Appointments.update operationId: Activity_modifyAppointment description: Modifies Appointment or Appointments with given id(s) parameters: - description: ID of Appointment to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Appointment on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAppointmentInput' responses: '200': description: Modification confirmation. Returns resulting Appointment content: application/json: schema: $ref: '#/components/schemas/ActivityModifyAppointmentResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6zio2mesg6763 /entities/Appointments: get: tags: - Activity summary: Appointments.list operationId: Activity_getAllAppointments description: Returns all defined Appointments parameters: - description: if enabled, deleted Appointments are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Appointments content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllAppointmentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qzzkjmyxprsuc post: tags: - Activity summary: Appointments.create operationId: Activity_createNewAppointment description: Creates new Appointment parameters: - description: >- Specify validation level of Appointment on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Appointment required: true content: application / json: schema: $ref: '#/components/schemas/createAppointmentInput' responses: '201': description: Creation confirmation. Returns created Appointment content: application/json: schema: $ref: '#/components/schemas/ActivityCreateNewAppointmentResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3hwgg2tz8l2la /entities/Appointments/batch-delete: post: tags: - Activity summary: Appointments.batch_delete operationId: Activity_removeAppointments description: Removes Appointments with given list of ids parameters: - description: >- Specify validation level of Appointments on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveAppointmentsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveAppointmentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lrcgeuj4e6hwh /entities/Appointments/batch-modify: post: tags: - Activity summary: Appointments.batch_create_or_update operationId: Activity_modifyBatchAppointments description: Create or update an batch of Appointments parameters: - description: >- Specify validation level of Appointments on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Appointment required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyBatchAppointmentsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated Appointments content: application/json: schema: $ref: '#/components/schemas/ActivityModifyBatchAppointmentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mcg9c2t6zz6hd /entities/AppointmentClientInviteesRelations/{id}: get: tags: - Activity summary: AppointmentClientInviteesRelations.get operationId: Activity_getById description: Returns AppointmentClientInviteesRelation with given id parameters: - description: ID of AppointmentClientInviteesRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AppointmentClientInviteesRelation data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: caeoybt8m6yzf delete: tags: - Activity summary: AppointmentClientInviteesRelations.delete operationId: Activity_removeById description: Removes AppointmentClientInviteesRelation with given id parameters: - description: ID of AppointmentClientInviteesRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentClientInviteesRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m381d2nmox0fk patch: tags: - Activity summary: AppointmentClientInviteesRelations.update operationId: Activity_updateAppointmentClientInviteesRelation description: >- Modifies AppointmentClientInviteesRelation or AppointmentClientInviteesRelations with given id(s) parameters: - description: ID of AppointmentClientInviteesRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentClientInviteesRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateAppointmentClientInviteesRelationInput responses: '200': description: >- Modification confirmation. Returns resulting AppointmentClientInviteesRelation content: application/json: schema: $ref: >- #/components/schemas/ActivityUpdateAppointmentClientInviteesRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iy0z345owmv8u /entities/AppointmentClientInviteesRelations: get: tags: - Activity summary: AppointmentClientInviteesRelations.list operationId: Activity_listAppointmentClientInviteesRelations description: Returns all defined AppointmentClientInviteesRelations parameters: - description: >- if enabled, deleted AppointmentClientInviteesRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AppointmentClientInviteesRelations content: application/json: schema: $ref: >- #/components/schemas/ActivityListAppointmentClientInviteesRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 11dpp789099pq post: tags: - Activity summary: AppointmentClientInviteesRelations.create operationId: Activity_createRelation description: Creates new AppointmentClientInviteesRelation parameters: - description: >- Specify validation level of AppointmentClientInviteesRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentClientInviteesRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createAppointmentClientInviteesRelationInput responses: '201': description: >- Creation confirmation. Returns created AppointmentClientInviteesRelation content: application/json: schema: $ref: '#/components/schemas/ActivityCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j7zcvbdzdwpq9 /entities/AppointmentClientInviteesRelations/batch-delete: post: tags: - Activity summary: AppointmentClientInviteesRelations.batch_delete operationId: Activity_removeBatchByIds description: Removes AppointmentClientInviteesRelations with given list of ids parameters: - description: >- Specify validation level of AppointmentClientInviteesRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentClientInviteesRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 58tyjfhw6ste1 /entities/AppointmentClientInviteesRelations/batch-modify: post: tags: - Activity summary: AppointmentClientInviteesRelations.batch_create_or_update operationId: Activity_batchCreateOrUpdate description: Create or update an batch of AppointmentClientInviteesRelations parameters: - description: >- Specify validation level of AppointmentClientInviteesRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentClientInviteesRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentClientInviteesRelation required: true content: application / json: schema: $ref: '#/components/schemas/ActivityBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AppointmentClientInviteesRelations content: application/json: schema: $ref: '#/components/schemas/ActivityBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rv1p67hhgjqja /entities/AppointmentContactInviteesRelations/{id}: get: tags: - Activity summary: AppointmentContactInviteesRelations.get operationId: Activity_getById description: Returns AppointmentContactInviteesRelation with given id parameters: - description: ID of AppointmentContactInviteesRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AppointmentContactInviteesRelation data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j1jl6su70wb0t delete: tags: - Activity summary: AppointmentContactInviteesRelations.delete operationId: Activity_removeById description: Removes AppointmentContactInviteesRelation with given id parameters: - description: ID of AppointmentContactInviteesRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentContactInviteesRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ojn1dpti4lku patch: tags: - Activity summary: AppointmentContactInviteesRelations.update operationId: Activity_updateRelation description: >- Modifies AppointmentContactInviteesRelation or AppointmentContactInviteesRelations with given id(s) parameters: - description: ID of AppointmentContactInviteesRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentContactInviteesRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateAppointmentContactInviteesRelationInput responses: '200': description: >- Modification confirmation. Returns resulting AppointmentContactInviteesRelation content: application/json: schema: $ref: '#/components/schemas/ActivityUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rlvmasmbc2rlo /entities/AppointmentContactInviteesRelations: get: tags: - Activity summary: AppointmentContactInviteesRelations.list operationId: Activity_listAppointmentContactInviteesRelations description: Returns all defined AppointmentContactInviteesRelations parameters: - description: >- if enabled, deleted AppointmentContactInviteesRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AppointmentContactInviteesRelations content: application/json: schema: $ref: >- #/components/schemas/ActivityListAppointmentContactInviteesRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gqut6egkw26xj post: tags: - Activity summary: AppointmentContactInviteesRelations.create operationId: Activity_createRelation description: Creates new AppointmentContactInviteesRelation parameters: - description: >- Specify validation level of AppointmentContactInviteesRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentContactInviteesRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createAppointmentContactInviteesRelationInput responses: '201': description: >- Creation confirmation. Returns created AppointmentContactInviteesRelation content: application/json: schema: $ref: '#/components/schemas/ActivityCreateRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4nd406h0n4wds /entities/AppointmentContactInviteesRelations/batch-delete: post: tags: - Activity summary: AppointmentContactInviteesRelations.batch_delete operationId: Activity_removeBatch description: Removes AppointmentContactInviteesRelations with given list of ids parameters: - description: >- Specify validation level of AppointmentContactInviteesRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentContactInviteesRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 221974ca8vmja /entities/AppointmentContactInviteesRelations/batch-modify: post: tags: - Activity summary: AppointmentContactInviteesRelations.batch_create_or_update operationId: Activity_batchCreateOrUpdate description: Create or update an batch of AppointmentContactInviteesRelations parameters: - description: >- Specify validation level of AppointmentContactInviteesRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentContactInviteesRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentContactInviteesRelation required: true content: application / json: schema: $ref: '#/components/schemas/ActivityBatchCreateOrUpdateRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AppointmentContactInviteesRelations content: application/json: schema: $ref: '#/components/schemas/ActivityBatchCreateOrUpdate200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qeifpyeprzxyd /entities/AppointmentReminders/{id}: get: tags: - Activity summary: AppointmentReminders.get operationId: Activity_getById description: Returns AppointmentReminder with given id parameters: - description: ID of AppointmentReminder to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AppointmentReminder data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ghxqhfyfnjhe9 delete: tags: - Activity summary: AppointmentReminders.delete operationId: Activity_removeById description: Removes AppointmentReminder with given id parameters: - description: ID of AppointmentReminder to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentReminder on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mm0y2bp13q84o patch: tags: - Activity summary: AppointmentReminders.update operationId: Activity_modifyAppointmentReminder description: Modifies AppointmentReminder or AppointmentReminders with given id(s) parameters: - description: ID of AppointmentReminder to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentReminder on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAppointmentReminderInput' responses: '200': description: Modification confirmation. Returns resulting AppointmentReminder content: application/json: schema: $ref: '#/components/schemas/ActivityModifyAppointmentReminderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4u82xrryi6wuj /entities/AppointmentReminders: get: tags: - Activity summary: AppointmentReminders.list operationId: Activity_getAllAppointmentReminders description: Returns all defined AppointmentReminders parameters: - description: if enabled, deleted AppointmentReminders are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AppointmentReminders content: application/json: schema: $ref: >- #/components/schemas/ActivityGetAllAppointmentRemindersResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gm9xa2903001h post: tags: - Activity summary: AppointmentReminders.create operationId: Activity_createAppointmentReminder description: Creates new AppointmentReminder parameters: - description: >- Specify validation level of AppointmentReminder on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentReminder required: true content: application / json: schema: $ref: '#/components/schemas/createAppointmentReminderInput' responses: '201': description: Creation confirmation. Returns created AppointmentReminder content: application/json: schema: $ref: '#/components/schemas/ActivityCreateAppointmentReminderResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0xvbpw1csqdtp /entities/AppointmentReminders/batch-delete: post: tags: - Activity summary: AppointmentReminders.batch_delete operationId: Activity_removeBatchAppointmentReminders description: Removes AppointmentReminders with given list of ids parameters: - description: >- Specify validation level of AppointmentReminders on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentReminders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/ActivityRemoveBatchAppointmentRemindersRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ActivityRemoveBatchAppointmentRemindersResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6icyfvrjxz5jy /entities/AppointmentReminders/batch-modify: post: tags: - Activity summary: AppointmentReminders.batch_create_or_update operationId: Activity_modifyBatchReminder description: Create or update an batch of AppointmentReminders parameters: - description: >- Specify validation level of AppointmentReminders on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentReminders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentReminder required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyBatchReminderRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AppointmentReminders content: application/json: schema: $ref: '#/components/schemas/ActivityModifyBatchReminderResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vl2huf2ojk5w6 /entities/AppointmentSchedules/{id}: get: tags: - Activity summary: AppointmentSchedules.get operationId: Activity_getById description: Returns AppointmentSchedule with given id parameters: - description: ID of AppointmentSchedule to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AppointmentSchedule data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yqqn4i6bvyego delete: tags: - Activity summary: AppointmentSchedules.delete operationId: Activity_removeById description: Removes AppointmentSchedule with given id parameters: - description: ID of AppointmentSchedule to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentSchedule on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 53578oza41l4f patch: tags: - Activity summary: AppointmentSchedules.update operationId: Activity_modifyAppointmentSchedule description: Modifies AppointmentSchedule or AppointmentSchedules with given id(s) parameters: - description: ID of AppointmentSchedule to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAppointmentScheduleInput' responses: '200': description: Modification confirmation. Returns resulting AppointmentSchedule content: application/json: schema: $ref: '#/components/schemas/ActivityModifyAppointmentScheduleResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zj932zj8pxl3z /entities/AppointmentSchedules: get: tags: - Activity summary: AppointmentSchedules.list operationId: Activity_getAllAppointmentSchedules description: Returns all defined AppointmentSchedules parameters: - description: if enabled, deleted AppointmentSchedules are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AppointmentSchedules content: application/json: schema: $ref: >- #/components/schemas/ActivityGetAllAppointmentSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2hcybjri2pafe post: tags: - Activity summary: AppointmentSchedules.create operationId: Activity_createAppointmentSchedule description: Creates new AppointmentSchedule parameters: - description: >- Specify validation level of AppointmentSchedule on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentSchedule required: true content: application / json: schema: $ref: '#/components/schemas/createAppointmentScheduleInput' responses: '201': description: Creation confirmation. Returns created AppointmentSchedule content: application/json: schema: $ref: '#/components/schemas/ActivityCreateAppointmentScheduleResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4701cow877g13 /entities/AppointmentSchedules/batch-delete: post: tags: - Activity summary: AppointmentSchedules.batch_delete operationId: Activity_removeBatchByIds description: Removes AppointmentSchedules with given list of ids parameters: - description: >- Specify validation level of AppointmentSchedules on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatchByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5zysbfsfp4g0u /entities/AppointmentSchedules/batch-modify: post: tags: - Activity summary: AppointmentSchedules.batch_create_or_update operationId: Activity_modifyBatchAppointmentSchedules description: Create or update an batch of AppointmentSchedules parameters: - description: >- Specify validation level of AppointmentSchedules on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentSchedule required: true content: application / json: schema: $ref: >- #/components/schemas/ActivityModifyBatchAppointmentSchedulesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated AppointmentSchedules content: application/json: schema: $ref: >- #/components/schemas/ActivityModifyBatchAppointmentSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4iy587ga82okf /entities/AppointmentTypes/{id}: get: tags: - Activity summary: AppointmentTypes.get operationId: Activity_getById description: Returns AppointmentType with given id parameters: - description: ID of AppointmentType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: AppointmentType data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 16zru4l7nx9yb delete: tags: - Activity summary: AppointmentTypes.delete operationId: Activity_removeById description: Removes AppointmentType with given id parameters: - description: ID of AppointmentType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8vs8upeoykl1h patch: tags: - Activity summary: AppointmentTypes.update operationId: Activity_modifyAppointmentType description: Modifies AppointmentType or AppointmentTypes with given id(s) parameters: - description: ID of AppointmentType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of AppointmentType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAppointmentTypeInput' responses: '200': description: Modification confirmation. Returns resulting AppointmentType content: application/json: schema: $ref: '#/components/schemas/ActivityModifyAppointmentTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 31mgaf4iqy836 /entities/AppointmentTypes: get: tags: - Activity summary: AppointmentTypes.list operationId: Activity_getAllAppointmentTypes description: Returns all defined AppointmentTypes parameters: - description: if enabled, deleted AppointmentTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AppointmentTypes content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllAppointmentTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kf4hu58pllrtt post: tags: - Activity summary: AppointmentTypes.create operationId: Activity_createAppointmentType description: Creates new AppointmentType parameters: - description: >- Specify validation level of AppointmentType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentType required: true content: application / json: schema: $ref: '#/components/schemas/createAppointmentTypeInput' responses: '201': description: Creation confirmation. Returns created AppointmentType content: application/json: schema: $ref: '#/components/schemas/ActivityCreateAppointmentTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9tqt8kjo4gkbg /entities/AppointmentTypes/batch-delete: post: tags: - Activity summary: AppointmentTypes.batch_delete operationId: Activity_removeBatch description: Removes AppointmentTypes with given list of ids parameters: - description: >- Specify validation level of AppointmentTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatch200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r2s0wgb5ssv6y /entities/AppointmentTypes/batch-modify: post: tags: - Activity summary: AppointmentTypes.batch_create_or_update operationId: Activity_modifyAppointmentTypesBatch description: Create or update an batch of AppointmentTypes parameters: - description: >- Specify validation level of AppointmentTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for AppointmentTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new AppointmentType required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyAppointmentTypesBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated AppointmentTypes content: application/json: schema: $ref: >- #/components/schemas/ActivityModifyAppointmentTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xerpvtz9zdjth /entities/Approvals/{id}: get: tags: - Approval summary: Approvals.get operationId: Approval_getById description: Returns Approval with given id parameters: - description: ID of Approval to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Approval data content: application/json: schema: $ref: '#/components/schemas/ApprovalGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a6onab89e27g8 delete: tags: - Approval summary: Approvals.delete operationId: Approval_removeById description: Removes Approval with given id parameters: - description: ID of Approval to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Approval 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ucwwqg1jt5w0t patch: tags: - Approval summary: Approvals.update operationId: Approval_modifyById description: Modifies Approval or Approvals with given id(s) parameters: - description: ID of Approval to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Approval 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateApprovalInput' responses: '200': description: Modification confirmation. Returns resulting Approval content: application/json: schema: $ref: '#/components/schemas/ApprovalModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: odwny9rjv4b6l /entities/Approvals: get: tags: - Approval summary: Approvals.list operationId: Approval_getAll description: Returns all defined Approvals parameters: - description: if enabled, deleted Approvals are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Approvals content: application/json: schema: $ref: '#/components/schemas/ApprovalGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1j0y3blqcxsnj post: tags: - Approval summary: Approvals.create operationId: Approval_generateNew description: Creates new Approval parameters: - description: >- Specify validation level of Approval 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Approval required: true content: application / json: schema: $ref: '#/components/schemas/createApprovalInput' responses: '201': description: Creation confirmation. Returns created Approval content: application/json: schema: $ref: '#/components/schemas/ApprovalGenerateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2nfh8kqlsrgn1 /entities/Approvals/batch-delete: post: tags: - Approval summary: Approvals.batch_delete operationId: Approval_removeBatch description: Removes Approvals with given list of ids parameters: - description: >- Specify validation level of Approvals 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Approvals. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s3ex47bc0bvz7 /entities/Approvals/batch-modify: post: tags: - Approval summary: Approvals.batch_create_or_update operationId: Approval_modifyBatchApprovals description: Create or update an batch of Approvals parameters: - description: >- Specify validation level of Approvals 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Approvals. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Approval required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalModifyBatchApprovalsRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Approvals content: application/json: schema: $ref: '#/components/schemas/ApprovalModifyBatchApprovalsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u1kk8e1q6nivj /entities/ApprovalApprovers/{id}: get: tags: - Approval summary: ApprovalApprovers.get operationId: Approval_getById description: Returns ApprovalApprover with given id parameters: - description: ID of ApprovalApprover to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ApprovalApprover data content: application/json: schema: $ref: '#/components/schemas/ApprovalGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cgl7mt3a31itm delete: tags: - Approval summary: ApprovalApprovers.delete operationId: Approval_removeById description: Removes ApprovalApprover with given id parameters: - description: ID of ApprovalApprover to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalApprover 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pyl8ojhnkbeao patch: tags: - Approval summary: ApprovalApprovers.update operationId: Approval_modifyApprover description: Modifies ApprovalApprover or ApprovalApprovers with given id(s) parameters: - description: ID of ApprovalApprover to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalApprover 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateApprovalApproverInput' responses: '200': description: Modification confirmation. Returns resulting ApprovalApprover content: application/json: schema: $ref: '#/components/schemas/ApprovalModifyApproverResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o9mf0w8oghz00 /entities/ApprovalApprovers: get: tags: - Approval summary: ApprovalApprovers.list operationId: Approval_getAllApprovers description: Returns all defined ApprovalApprovers parameters: - description: if enabled, deleted ApprovalApprovers are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ApprovalApprovers content: application/json: schema: $ref: '#/components/schemas/ApprovalGetAllApproversResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nsqfylqp2d6s8 post: tags: - Approval summary: ApprovalApprovers.create operationId: Approval_createNewApprover description: Creates new ApprovalApprover parameters: - description: >- Specify validation level of ApprovalApprover 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalApprover required: true content: application / json: schema: $ref: '#/components/schemas/createApprovalApproverInput' responses: '201': description: Creation confirmation. Returns created ApprovalApprover content: application/json: schema: $ref: '#/components/schemas/ApprovalCreateNewApproverResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jvy5gcx4egfxh /entities/ApprovalApprovers/batch-delete: post: tags: - Approval summary: ApprovalApprovers.batch_delete operationId: Approval_removeWithIds description: Removes ApprovalApprovers with given list of ids parameters: - description: >- Specify validation level of ApprovalApprovers 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalApprovers. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalRemoveWithIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveWithIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ms868tfsmp1ps /entities/ApprovalApprovers/batch-modify: post: tags: - Approval summary: ApprovalApprovers.batch_create_or_update operationId: Approval_modifyBatchApprovalApprovers description: Create or update an batch of ApprovalApprovers parameters: - description: >- Specify validation level of ApprovalApprovers 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalApprovers. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalApprover required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalModifyBatchApprovalApproversRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ApprovalApprovers content: application/json: schema: $ref: >- #/components/schemas/ApprovalModifyBatchApprovalApproversResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: asuhuc3sbtx0t /entities/ApprovalProcesses/{id}: get: tags: - Approval summary: ApprovalProcesses.get operationId: Approval_getById description: Returns ApprovalProcess with given id parameters: - description: ID of ApprovalProcess to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ApprovalProcess data content: application/json: schema: $ref: '#/components/schemas/ApprovalGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o3bzaawhybu4d delete: tags: - Approval summary: ApprovalProcesses.delete operationId: Approval_removeById description: Removes ApprovalProcess with given id parameters: - description: ID of ApprovalProcess to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalProcess 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vdkk8x35585x8 patch: tags: - Approval summary: ApprovalProcesses.update operationId: Approval_modifyProcessById description: Modifies ApprovalProcess or ApprovalProcesses with given id(s) parameters: - description: ID of ApprovalProcess to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateApprovalProcessInput' responses: '200': description: Modification confirmation. Returns resulting ApprovalProcess content: application/json: schema: $ref: '#/components/schemas/ApprovalModifyProcessByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 19geff3j5zpi8 /entities/ApprovalProcesses: get: tags: - Approval summary: ApprovalProcesses.list operationId: Approval_getAllDefined description: Returns all defined ApprovalProcesses parameters: - description: if enabled, deleted ApprovalProcesses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ApprovalProcesses content: application/json: schema: $ref: '#/components/schemas/ApprovalGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6r9ruuv8nr6y8 post: tags: - Approval summary: ApprovalProcesses.create operationId: Approval_createNewApproval description: Creates new ApprovalProcess parameters: - description: >- Specify validation level of ApprovalProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalProcess required: true content: application / json: schema: $ref: '#/components/schemas/createApprovalProcessInput' responses: '201': description: Creation confirmation. Returns created ApprovalProcess content: application/json: schema: $ref: '#/components/schemas/ApprovalCreateNewApprovalResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: emtu87j6m5v5h /entities/ApprovalProcesses/batch-delete: post: tags: - Approval summary: ApprovalProcesses.batch_delete operationId: Approval_removeBatch description: Removes ApprovalProcesses with given list of ids parameters: - description: >- Specify validation level of ApprovalProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sqtw7nhm5xrs6 /entities/ApprovalProcesses/batch-modify: post: tags: - Approval summary: ApprovalProcesses.batch_create_or_update operationId: Approval_modifyBatchApprovalProcesses description: Create or update an batch of ApprovalProcesses parameters: - description: >- Specify validation level of ApprovalProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalProcess required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalModifyBatchApprovalProcessesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ApprovalProcesses content: application/json: schema: $ref: >- #/components/schemas/ApprovalModifyBatchApprovalProcessesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pmtn7gfhev9h8 /entities/ApprovalProcessActivityLogLines/{id}: get: tags: - Approval summary: ApprovalProcessActivityLogLines.get operationId: Approval_getById description: Returns ApprovalProcessActivityLogLine with given id parameters: - description: ID of ApprovalProcessActivityLogLine to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ApprovalProcessActivityLogLine data content: application/json: schema: $ref: '#/components/schemas/ApprovalGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bxyln19784h87 delete: tags: - Approval summary: ApprovalProcessActivityLogLines.delete operationId: Approval_removeById description: Removes ApprovalProcessActivityLogLine with given id parameters: - description: ID of ApprovalProcessActivityLogLine to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bxhcdb1qrsqt0 patch: tags: - Approval summary: ApprovalProcessActivityLogLines.update operationId: Approval_modifyLogLine description: >- Modifies ApprovalProcessActivityLogLine or ApprovalProcessActivityLogLines with given id(s) parameters: - description: ID of ApprovalProcessActivityLogLine to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ApprovalProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateApprovalProcessActivityLogLineInput' responses: '200': description: >- Modification confirmation. Returns resulting ApprovalProcessActivityLogLine content: application/json: schema: $ref: '#/components/schemas/ApprovalModifyLogLineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ift04nmolb6rp /entities/ApprovalProcessActivityLogLines: get: tags: - Approval summary: ApprovalProcessActivityLogLines.list operationId: Approval_listApprovalProcessActivityLogLines description: Returns all defined ApprovalProcessActivityLogLines parameters: - description: >- if enabled, deleted ApprovalProcessActivityLogLines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ApprovalProcessActivityLogLines content: application/json: schema: $ref: >- #/components/schemas/ApprovalListApprovalProcessActivityLogLinesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ty1y98261iw4p post: tags: - Approval summary: ApprovalProcessActivityLogLines.create operationId: Approval_createLogLine description: Creates new ApprovalProcessActivityLogLine parameters: - description: >- Specify validation level of ApprovalProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalProcessActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/createApprovalProcessActivityLogLineInput' responses: '201': description: >- Creation confirmation. Returns created ApprovalProcessActivityLogLine content: application/json: schema: $ref: '#/components/schemas/ApprovalCreateLogLineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kku873mrm9dxx /entities/ApprovalProcessActivityLogLines/batch-delete: post: tags: - Approval summary: ApprovalProcessActivityLogLines.batch_delete operationId: Approval_removeBatchByIds description: Removes ApprovalProcessActivityLogLines with given list of ids parameters: - description: >- Specify validation level of ApprovalProcessActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ApprovalRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zb316zayhsil3 /entities/ApprovalProcessActivityLogLines/batch-modify: post: tags: - Approval summary: ApprovalProcessActivityLogLines.batch_create_or_update operationId: Approval_updateBatch description: Create or update an batch of ApprovalProcessActivityLogLines parameters: - description: >- Specify validation level of ApprovalProcessActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ApprovalProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ApprovalProcessActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/ApprovalUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ApprovalProcessActivityLogLines content: application/json: schema: $ref: '#/components/schemas/ApprovalUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7qdp4xniw9gp6 /entities/Calls/{id}: get: tags: - Call summary: Calls.get operationId: Call_getById description: Returns Call with given id parameters: - description: ID of Call to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Call data content: application/json: schema: $ref: '#/components/schemas/CallGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jklt9re0vptxv delete: tags: - Call summary: Calls.delete operationId: Call_removeById description: Removes Call with given id parameters: - description: ID of Call to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Call 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CallRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o8e8d7b2jfld1 patch: tags: - Call summary: Calls.update operationId: Call_modifyById description: Modifies Call or Calls with given id(s) parameters: - description: ID of Call to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Call 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCallInput' responses: '200': description: Modification confirmation. Returns resulting Call content: application/json: schema: $ref: '#/components/schemas/CallModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1jkhbfwda77s8 /entities/Calls: get: tags: - Call summary: Calls.list operationId: Call_getAll description: Returns all defined Calls parameters: - description: if enabled, deleted Calls are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Calls content: application/json: schema: $ref: '#/components/schemas/CallGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gs2435wvmccdk post: tags: - Call summary: Calls.create operationId: Call_newCall description: Creates new Call parameters: - description: >- Specify validation level of Call 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Call required: true content: application / json: schema: $ref: '#/components/schemas/createCallInput' responses: '201': description: Creation confirmation. Returns created Call content: application/json: schema: $ref: '#/components/schemas/CallNewCallResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 36dfwvvnf2qr3 /entities/Calls/batch-delete: post: tags: - Call summary: Calls.batch_delete operationId: Call_removeBatch description: Removes Calls with given list of ids parameters: - description: >- Specify validation level of Calls 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Calls. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CallRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CallRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ejl3cwfuinv64 /entities/Calls/batch-modify: post: tags: - Call summary: Calls.batch_create_or_update operationId: Call_batchModify description: Create or update an batch of Calls parameters: - description: >- Specify validation level of Calls 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Calls. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Call required: true content: application / json: schema: $ref: '#/components/schemas/CallBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Calls content: application/json: schema: $ref: '#/components/schemas/CallBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: czaism1uvw3cr /entities/Clients/{id}: get: tags: - Client summary: Clients.get operationId: Client_getById description: Returns Client with given id parameters: - description: ID of Client to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Client data content: application/json: schema: $ref: '#/components/schemas/ClientGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rvp08rr7j1b4b delete: tags: - Client summary: Clients.delete operationId: Client_removeById description: Removes Client with given id parameters: - description: ID of Client to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Client 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: awy1umimxvpcw patch: tags: - Client summary: Clients.update operationId: Client_modifyById description: Modifies Client or Clients with given id(s) parameters: - description: ID of Client to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Client 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateClientInput' responses: '200': description: Modification confirmation. Returns resulting Client content: application/json: schema: $ref: '#/components/schemas/ClientModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kqtslbdmnt5nt /entities/Clients: get: tags: - Client summary: Clients.list operationId: Client_getAllDefinedClients description: Returns all defined Clients parameters: - description: if enabled, deleted Clients are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Clients content: application/json: schema: $ref: '#/components/schemas/ClientGetAllDefinedClientsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: knd4fofmes5s5 post: tags: - Client summary: Clients.create operationId: Client_registerNewClient description: Creates new Client parameters: - description: >- Specify validation level of Client 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Client required: true content: application / json: schema: $ref: '#/components/schemas/createClientInput' responses: '201': description: Creation confirmation. Returns created Client content: application/json: schema: $ref: '#/components/schemas/ClientRegisterNewClientResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1jss6ui1v2o2e /entities/Clients/batch-delete: post: tags: - Client summary: Clients.batch_delete operationId: Client_removeBatch description: Removes Clients with given list of ids parameters: - description: >- Specify validation level of Clients 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Clients. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ClientRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gxv5tj9amb5rm /entities/Clients/batch-modify: post: tags: - Client summary: Clients.batch_create_or_update operationId: Client_batchModify description: Create or update an batch of Clients parameters: - description: >- Specify validation level of Clients 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Clients. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Client required: true content: application / json: schema: $ref: '#/components/schemas/ClientBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Clients content: application/json: schema: $ref: '#/components/schemas/ClientBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wtfnqpli20goq /entities/ClientExcludedOppties/{id}: get: tags: - Client summary: ClientExcludedOppties.get operationId: Client_getById description: Returns ClientExcludedOppty with given id parameters: - description: ID of ClientExcludedOppty to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ClientExcludedOppty data content: application/json: schema: $ref: '#/components/schemas/ClientGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r5r3ylu146nhh delete: tags: - Client summary: ClientExcludedOppties.delete operationId: Client_removeById description: Removes ClientExcludedOppty with given id parameters: - description: ID of ClientExcludedOppty to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientExcludedOppty 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j6j624j562krs patch: tags: - Client summary: ClientExcludedOppties.update operationId: Client_modifyExcludedOpptiesById description: Modifies ClientExcludedOppty or ClientExcludedOppties with given id(s) parameters: - description: ID of ClientExcludedOppty to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientExcludedOppty 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateClientExcludedOpptyInput' responses: '200': description: Modification confirmation. Returns resulting ClientExcludedOppty content: application/json: schema: $ref: '#/components/schemas/ClientModifyExcludedOpptiesByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 90yaq4ny0h23e /entities/ClientExcludedOppties: get: tags: - Client summary: ClientExcludedOppties.list operationId: Client_listExcludedOpportunities description: Returns all defined ClientExcludedOppties parameters: - description: if enabled, deleted ClientExcludedOppties are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ClientExcludedOppties content: application/json: schema: $ref: '#/components/schemas/ClientListExcludedOpportunitiesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rs91osweet20j post: tags: - Client summary: ClientExcludedOppties.create operationId: Client_createNewOppty description: Creates new ClientExcludedOppty parameters: - description: >- Specify validation level of ClientExcludedOppty 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ClientExcludedOppty required: true content: application / json: schema: $ref: '#/components/schemas/createClientExcludedOpptyInput' responses: '201': description: Creation confirmation. Returns created ClientExcludedOppty content: application/json: schema: $ref: '#/components/schemas/ClientCreateNewOpptyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ef8ba5bq03e7j /entities/ClientExcludedOppties/batch-delete: post: tags: - Client summary: ClientExcludedOppties.batch_delete operationId: Client_removeBatch description: Removes ClientExcludedOppties with given list of ids parameters: - description: >- Specify validation level of ClientExcludedOppties 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientExcludedOppties. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ClientRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fini0izhea2rz /entities/ClientExcludedOppties/batch-modify: post: tags: - Client summary: ClientExcludedOppties.batch_create_or_update operationId: Client_modifyBatchClientExcludedOppties description: Create or update an batch of ClientExcludedOppties parameters: - description: >- Specify validation level of ClientExcludedOppties 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientExcludedOppties. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ClientExcludedOppty required: true content: application / json: schema: $ref: >- #/components/schemas/ClientModifyBatchClientExcludedOpptiesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ClientExcludedOppties content: application/json: schema: $ref: >- #/components/schemas/ClientModifyBatchClientExcludedOpptiesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3mt46jdzqyx3w /entities/ClientFavorites/{id}: get: tags: - Client summary: ClientFavorites.get operationId: Client_getById description: Returns ClientFavorite with given id parameters: - description: ID of ClientFavorite to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ClientFavorite data content: application/json: schema: $ref: '#/components/schemas/ClientGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ubaea1fb4mjkf delete: tags: - Client summary: ClientFavorites.delete operationId: Client_removeById description: Removes ClientFavorite with given id parameters: - description: ID of ClientFavorite to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientFavorite 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wvpnbl3kmpq1n patch: tags: - Client summary: ClientFavorites.update operationId: Client_updateClientFavorite description: Modifies ClientFavorite or ClientFavorites with given id(s) parameters: - description: ID of ClientFavorite to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientFavorite 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateClientFavoriteInput' responses: '200': description: Modification confirmation. Returns resulting ClientFavorite content: application/json: schema: $ref: '#/components/schemas/ClientUpdateClientFavoriteResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nqk2pmkv0lxql /entities/ClientFavorites: get: tags: - Client summary: ClientFavorites.list operationId: Client_getAllFavorites description: Returns all defined ClientFavorites parameters: - description: if enabled, deleted ClientFavorites are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ClientFavorites content: application/json: schema: $ref: '#/components/schemas/ClientGetAllFavoritesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7gfr9xmqe5oca post: tags: - Client summary: ClientFavorites.create operationId: Client_createNewFavorite description: Creates new ClientFavorite parameters: - description: >- Specify validation level of ClientFavorite 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ClientFavorite required: true content: application / json: schema: $ref: '#/components/schemas/createClientFavoriteInput' responses: '201': description: Creation confirmation. Returns created ClientFavorite content: application/json: schema: $ref: '#/components/schemas/ClientCreateNewFavoriteResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 62aq6wkc3c0wu /entities/ClientFavorites/batch-delete: post: tags: - Client summary: ClientFavorites.batch_delete operationId: Client_removeBatchFavorites description: Removes ClientFavorites with given list of ids parameters: - description: >- Specify validation level of ClientFavorites 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientFavorites. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ClientRemoveBatchFavoritesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveBatchFavoritesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iuntcur43l97q /entities/ClientFavorites/batch-modify: post: tags: - Client summary: ClientFavorites.batch_create_or_update operationId: Client_modifyFavoritesBatch description: Create or update an batch of ClientFavorites parameters: - description: >- Specify validation level of ClientFavorites 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientFavorites. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ClientFavorite required: true content: application / json: schema: $ref: '#/components/schemas/ClientModifyFavoritesBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ClientFavorites content: application/json: schema: $ref: '#/components/schemas/ClientModifyFavoritesBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xji8watga76i5 /entities/ClientSettings/{id}: get: tags: - Client summary: ClientSettings.get operationId: Client_getSettingsById description: Returns ClientSetting with given id parameters: - description: ID of ClientSetting to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ClientSetting data content: application/json: schema: $ref: '#/components/schemas/ClientGetSettingsByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b07gju5d0p57b /entities/ClientSettings: get: tags: - Client summary: ClientSettings.list operationId: Client_getSettings description: Returns all defined ClientSettings parameters: - description: if enabled, deleted ClientSettings are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ClientSettings content: application/json: schema: $ref: '#/components/schemas/ClientGetSettingsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xajhv6nbomoyg /entities/ClientStoryReads/{id}: get: tags: - Client summary: ClientStoryReads.get operationId: Client_getById description: Returns ClientStoryRead with given id parameters: - description: ID of ClientStoryRead to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ClientStoryRead data content: application/json: schema: $ref: '#/components/schemas/ClientGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2mm0iobqdociw delete: tags: - Client summary: ClientStoryReads.delete operationId: Client_removeById description: Removes ClientStoryRead with given id parameters: - description: ID of ClientStoryRead to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientStoryRead 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6eyclibead0h1 patch: tags: - Client summary: ClientStoryReads.update operationId: Client_modifyById description: Modifies ClientStoryRead or ClientStoryReads with given id(s) parameters: - description: ID of ClientStoryRead to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ClientStoryRead 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateClientStoryReadInput' responses: '200': description: Modification confirmation. Returns resulting ClientStoryRead content: application/json: schema: $ref: '#/components/schemas/ClientModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e38kyq4k54ozw /entities/ClientStoryReads: get: tags: - Client summary: ClientStoryReads.list operationId: Client_getAllClientStoryReads description: Returns all defined ClientStoryReads parameters: - description: if enabled, deleted ClientStoryReads are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ClientStoryReads content: application/json: schema: $ref: '#/components/schemas/ClientGetAllClientStoryReadsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ndh8nu3x7sjre post: tags: - Client summary: ClientStoryReads.create operationId: Client_createClientStoryRead description: Creates new ClientStoryRead parameters: - description: >- Specify validation level of ClientStoryRead 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ClientStoryRead required: true content: application / json: schema: $ref: '#/components/schemas/createClientStoryReadInput' responses: '201': description: Creation confirmation. Returns created ClientStoryRead content: application/json: schema: $ref: '#/components/schemas/ClientCreateClientStoryReadResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2dy9ld8jw1ife /entities/ClientStoryReads/batch-delete: post: tags: - Client summary: ClientStoryReads.batch_delete operationId: Client_removeBatch description: Removes ClientStoryReads with given list of ids parameters: - description: >- Specify validation level of ClientStoryReads 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientStoryReads. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ClientRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ClientRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: afv11x7se4b0c /entities/ClientStoryReads/batch-modify: post: tags: - Client summary: ClientStoryReads.batch_create_or_update operationId: Client_createOrUpdateBatchClientStoryReads description: Create or update an batch of ClientStoryReads parameters: - description: >- Specify validation level of ClientStoryReads 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ClientStoryReads. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ClientStoryRead required: true content: application / json: schema: $ref: >- #/components/schemas/ClientCreateOrUpdateBatchClientStoryReadsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ClientStoryReads content: application/json: schema: $ref: >- #/components/schemas/ClientCreateOrUpdateBatchClientStoryReadsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2ktsewhusko6m /entities/CloudObjects/{id}: get: tags: - Document summary: CloudObjects.get operationId: Document_getById description: Returns CloudObject with given id parameters: - description: ID of CloudObject to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CloudObject data content: application/json: schema: $ref: '#/components/schemas/DocumentGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 09cbkwu9uoevw delete: tags: - Document summary: CloudObjects.delete operationId: Document_removeById description: Removes CloudObject with given id parameters: - description: ID of CloudObject to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObject 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ekxykh81a87k3 patch: tags: - Document summary: CloudObjects.update operationId: Document_modifyCloudObject description: Modifies CloudObject or CloudObjects with given id(s) parameters: - description: ID of CloudObject to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObject 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectInput' responses: '200': description: Modification confirmation. Returns resulting CloudObject content: application/json: schema: $ref: '#/components/schemas/DocumentModifyCloudObjectResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iencwq596eqoy /entities/CloudObjects: get: tags: - Document summary: CloudObjects.list operationId: Document_getAllCloudObjects description: Returns all defined CloudObjects parameters: - description: if enabled, deleted CloudObjects are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjects content: application/json: schema: $ref: '#/components/schemas/DocumentGetAllCloudObjectsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ea45cgszf4rnw post: tags: - Document summary: CloudObjects.create operationId: Document_createCloudObject description: Creates new CloudObject parameters: - description: >- Specify validation level of CloudObject 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CloudObject required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectInput' responses: '201': description: Creation confirmation. Returns created CloudObject content: application/json: schema: $ref: '#/components/schemas/DocumentCreateCloudObjectResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rnl765qc4d42p /entities/CloudObjects/batch-delete: post: tags: - Document summary: CloudObjects.batch_delete operationId: Document_removeByIds description: Removes CloudObjects with given list of ids parameters: - description: >- Specify validation level of CloudObjects 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DocumentRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 74uyflue165hc /entities/CloudObjects/batch-modify: post: tags: - Document summary: CloudObjects.batch_create_or_update operationId: Document_modifyCloudObjectsBatch description: Create or update an batch of CloudObjects parameters: - description: >- Specify validation level of CloudObjects 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CloudObject required: true content: application / json: schema: $ref: '#/components/schemas/DocumentModifyCloudObjectsBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated CloudObjects content: application/json: schema: $ref: '#/components/schemas/DocumentModifyCloudObjectsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aoeh8p9x63vmp /entities/CloudObjectFolders/{id}: get: tags: - Document summary: CloudObjectFolders.get operationId: Document_getById description: Returns CloudObjectFolder with given id parameters: - description: ID of CloudObjectFolder to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CloudObjectFolder data content: application/json: schema: $ref: '#/components/schemas/DocumentGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wb3071dsq3awx delete: tags: - Document summary: CloudObjectFolders.delete operationId: Document_removeById description: Removes CloudObjectFolder with given id parameters: - description: ID of CloudObjectFolder to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectFolder 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3a5ybejctiv0x patch: tags: - Document summary: CloudObjectFolders.update operationId: Document_modifyCloudObjectFolder description: Modifies CloudObjectFolder or CloudObjectFolders with given id(s) parameters: - description: ID of CloudObjectFolder to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectFolder 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectFolderInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectFolder content: application/json: schema: $ref: '#/components/schemas/DocumentModifyCloudObjectFolderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7d05v00dnm2fi /entities/CloudObjectFolders: get: tags: - Document summary: CloudObjectFolders.list operationId: Document_getAllCloudObjectFolders description: Returns all defined CloudObjectFolders parameters: - description: if enabled, deleted CloudObjectFolders are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectFolders content: application/json: schema: $ref: '#/components/schemas/DocumentGetAllCloudObjectFoldersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ud4zzm35iq3dk post: tags: - Document summary: CloudObjectFolders.create operationId: Document_createFolder description: Creates new CloudObjectFolder parameters: - description: >- Specify validation level of CloudObjectFolder 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectFolder required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectFolderInput' responses: '201': description: Creation confirmation. Returns created CloudObjectFolder content: application/json: schema: $ref: '#/components/schemas/DocumentCreateFolderResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4k0qb09tbbwbt /entities/CloudObjectFolders/batch-delete: post: tags: - Document summary: CloudObjectFolders.batch_delete operationId: Document_removeWithIds description: Removes CloudObjectFolders with given list of ids parameters: - description: >- Specify validation level of CloudObjectFolders 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DocumentRemoveWithIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveWithIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3iqxleuqiqkmu /entities/CloudObjectFolders/batch-modify: post: tags: - Document summary: CloudObjectFolders.batch_create_or_update operationId: Document_modifyCloudObjectFoldersBatch description: Create or update an batch of CloudObjectFolders parameters: - description: >- Specify validation level of CloudObjectFolders 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectFolder required: true content: application / json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectFoldersBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated CloudObjectFolders content: application/json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectFoldersBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vxtny0q86t36l /entities/CloudObjectRelations/{id}: get: tags: - Document summary: CloudObjectRelations.get operationId: Document_getById description: Returns CloudObjectRelation with given id parameters: - description: ID of CloudObjectRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CloudObjectRelation data content: application/json: schema: $ref: '#/components/schemas/DocumentGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 135ob9eup2uf1 delete: tags: - Document summary: CloudObjectRelations.delete operationId: Document_removeById description: Removes CloudObjectRelation with given id parameters: - description: ID of CloudObjectRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zol6zxb3pduql patch: tags: - Document summary: CloudObjectRelations.update operationId: Document_modifyCloudObjectRelations description: Modifies CloudObjectRelation or CloudObjectRelations with given id(s) parameters: - description: ID of CloudObjectRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectRelationInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectRelation content: application/json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectRelationsResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yhpdhl5dvhpqs /entities/CloudObjectRelations: get: tags: - Document summary: CloudObjectRelations.list operationId: Document_getAllCloudObjectRelations description: Returns all defined CloudObjectRelations parameters: - description: if enabled, deleted CloudObjectRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectRelations content: application/json: schema: $ref: >- #/components/schemas/DocumentGetAllCloudObjectRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q1wo072by5rfr post: tags: - Document summary: CloudObjectRelations.create operationId: Document_createRelation description: Creates new CloudObjectRelation parameters: - description: >- Specify validation level of CloudObjectRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectRelation required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectRelationInput' responses: '201': description: Creation confirmation. Returns created CloudObjectRelation content: application/json: schema: $ref: '#/components/schemas/DocumentCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g5j53nce6d3zz /entities/CloudObjectRelations/batch-delete: post: tags: - Document summary: CloudObjectRelations.batch_delete operationId: Document_removeWithIds description: Removes CloudObjectRelations with given list of ids parameters: - description: >- Specify validation level of CloudObjectRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DocumentRemoveWithIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveWithIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6vlaxlkp6ciae /entities/CloudObjectRelations/batch-modify: post: tags: - Document summary: CloudObjectRelations.batch_create_or_update operationId: Document_modifyCloudObjectRelationsBatch description: Create or update an batch of CloudObjectRelations parameters: - description: >- Specify validation level of CloudObjectRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectRelation required: true content: application / json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectRelationsBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated CloudObjectRelations content: application/json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectRelationsBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w5ehka54fra2d /entities/CloudObjectStepRelations/{id}: get: tags: - Document summary: CloudObjectStepRelations.get operationId: Document_getById description: Returns CloudObjectStepRelation with given id parameters: - description: ID of CloudObjectStepRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CloudObjectStepRelation data content: application/json: schema: $ref: '#/components/schemas/DocumentGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pwcd11bwm68ai delete: tags: - Document summary: CloudObjectStepRelations.delete operationId: Document_removeById description: Removes CloudObjectStepRelation with given id parameters: - description: ID of CloudObjectStepRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectStepRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: os9v4lh2rae89 patch: tags: - Document summary: CloudObjectStepRelations.update operationId: Document_modifyRelation description: >- Modifies CloudObjectStepRelation or CloudObjectStepRelations with given id(s) parameters: - description: ID of CloudObjectStepRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectStepRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectStepRelationInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectStepRelation content: application/json: schema: $ref: '#/components/schemas/DocumentModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p1w3b47hel5av /entities/CloudObjectStepRelations: get: tags: - Document summary: CloudObjectStepRelations.list operationId: Document_getAll description: Returns all defined CloudObjectStepRelations parameters: - description: if enabled, deleted CloudObjectStepRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectStepRelations content: application/json: schema: $ref: '#/components/schemas/DocumentGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yqpa0zs335f3x post: tags: - Document summary: CloudObjectStepRelations.create operationId: Document_createNewCloudObjectStepRelation description: Creates new CloudObjectStepRelation parameters: - description: >- Specify validation level of CloudObjectStepRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectStepRelation required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectStepRelationInput' responses: '201': description: Creation confirmation. Returns created CloudObjectStepRelation content: application/json: schema: $ref: >- #/components/schemas/DocumentCreateNewCloudObjectStepRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ynmnaf1lrniqb /entities/CloudObjectStepRelations/batch-delete: post: tags: - Document summary: CloudObjectStepRelations.batch_delete operationId: Document_removeCloudObjectStepRelations description: Removes CloudObjectStepRelations with given list of ids parameters: - description: >- Specify validation level of CloudObjectStepRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/DocumentRemoveCloudObjectStepRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/DocumentRemoveCloudObjectStepRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tl93e4s7meguh /entities/CloudObjectStepRelations/batch-modify: post: tags: - Document summary: CloudObjectStepRelations.batch_create_or_update operationId: Document_createOrUpdateBatchCloudObjectStepRelations description: Create or update an batch of CloudObjectStepRelations parameters: - description: >- Specify validation level of CloudObjectStepRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectStepRelation required: true content: application / json: schema: $ref: >- #/components/schemas/DocumentCreateOrUpdateBatchCloudObjectStepRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated CloudObjectStepRelations content: application/json: schema: $ref: >- #/components/schemas/DocumentCreateOrUpdateBatchCloudObjectStepRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m6y6kcat42wet /entities/CloudObjectTemplates/{id}: get: tags: - Document summary: CloudObjectTemplates.get operationId: Document_getById description: Returns CloudObjectTemplate with given id parameters: - description: ID of CloudObjectTemplate to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CloudObjectTemplate data content: application/json: schema: $ref: '#/components/schemas/DocumentGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tptoocia5ba8a delete: tags: - Document summary: CloudObjectTemplates.delete operationId: Document_removeById description: Removes CloudObjectTemplate with given id parameters: - description: ID of CloudObjectTemplate to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectTemplate 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0j65l8l8v24mb patch: tags: - Document summary: CloudObjectTemplates.update operationId: Document_modifyCloudObjectTemplate description: Modifies CloudObjectTemplate or CloudObjectTemplates with given id(s) parameters: - description: ID of CloudObjectTemplate to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CloudObjectTemplate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectTemplateInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectTemplate content: application/json: schema: $ref: '#/components/schemas/DocumentModifyCloudObjectTemplateResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7atcyln4kdky5 /entities/CloudObjectTemplates: get: tags: - Document summary: CloudObjectTemplates.list operationId: Document_getAllCloudObjectTemplates description: Returns all defined CloudObjectTemplates parameters: - description: if enabled, deleted CloudObjectTemplates are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectTemplates content: application/json: schema: $ref: >- #/components/schemas/DocumentGetAllCloudObjectTemplatesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8hfsfzzzavepm post: tags: - Document summary: CloudObjectTemplates.create operationId: Document_createNewCloudObjectTemplate description: Creates new CloudObjectTemplate parameters: - description: >- Specify validation level of CloudObjectTemplate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectTemplate required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectTemplateInput' responses: '201': description: Creation confirmation. Returns created CloudObjectTemplate content: application/json: schema: $ref: >- #/components/schemas/DocumentCreateNewCloudObjectTemplateResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y8o3o745mq6uk /entities/CloudObjectTemplates/batch-delete: post: tags: - Document summary: CloudObjectTemplates.batch_delete operationId: Document_removeWithIds description: Removes CloudObjectTemplates with given list of ids parameters: - description: >- Specify validation level of CloudObjectTemplates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DocumentRemoveWithIdsRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DocumentRemoveWithIds200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: apwdkwa2vpfty /entities/CloudObjectTemplates/batch-modify: post: tags: - Document summary: CloudObjectTemplates.batch_create_or_update operationId: Document_modifyCloudObjectTemplatesBatch description: Create or update an batch of CloudObjectTemplates parameters: - description: >- Specify validation level of CloudObjectTemplates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CloudObjectTemplate required: true content: application / json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectTemplatesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated CloudObjectTemplates content: application/json: schema: $ref: >- #/components/schemas/DocumentModifyCloudObjectTemplatesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: imd5jfhqiovdl /entities/CompanyEmails/{id}: get: tags: - Company Email summary: CompanyEmails.get operationId: CompanyEmail_getById description: Returns CompanyEmail with given id parameters: - description: ID of CompanyEmail to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CompanyEmail data content: application/json: schema: $ref: '#/components/schemas/CompanyEmailGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ouvg0vsd5opag /entities/CompanyEmails: get: tags: - Company Email summary: CompanyEmails.list operationId: CompanyEmail_getAll description: Returns all defined CompanyEmails parameters: - description: if enabled, deleted CompanyEmails are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CompanyEmails content: application/json: schema: $ref: '#/components/schemas/CompanyEmailGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7y1huqvk03o7t /entities/Contacts/{id}: get: tags: - Contact summary: Contacts.get operationId: Contact_getById description: Returns Contact with given id parameters: - description: ID of Contact to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Contact data content: application/json: schema: $ref: '#/components/schemas/ContactGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vay76pdtw0o0b delete: tags: - Contact summary: Contacts.delete operationId: Contact_removeById description: Removes Contact with given id parameters: - description: ID of Contact to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Contact 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3a0nayh8tol0n patch: tags: - Contact summary: Contacts.update operationId: Contact_modifyById description: Modifies Contact or Contacts with given id(s) parameters: - description: ID of Contact to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Contact 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactInput' responses: '200': description: Modification confirmation. Returns resulting Contact content: application/json: schema: $ref: '#/components/schemas/ContactModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1nj25l4k6v8r3 /entities/Contacts: get: tags: - Contact summary: Contacts.list operationId: Contact_getAllDefined description: Returns all defined Contacts parameters: - description: if enabled, deleted Contacts are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Contacts content: application/json: schema: $ref: '#/components/schemas/ContactGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5m62qxldzaa6s post: tags: - Contact summary: Contacts.create operationId: Contact_addNew description: Creates new Contact parameters: - description: >- Specify validation level of Contact 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Contact required: true content: application / json: schema: $ref: '#/components/schemas/createContactInput' responses: '201': description: Creation confirmation. Returns created Contact content: application/json: schema: $ref: '#/components/schemas/ContactAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8ke7v835yunnp /entities/Contacts/merge: post: tags: - Contact summary: Contacts.merge operationId: Contact_mergeContacts description: Merger multiple Contacts into master record. parameters: [] requestBody: description: Entity . required: true content: application/json: schema: $ref: '#/components/schemas/ContactMergeContactsRequest' responses: '200': description: Merged entity content: application/json: schema: $ref: '#/components/schemas/ContactMergeContactsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0olo71cz0zvkn /entities/Contacts/batch-delete: post: tags: - Contact summary: Contacts.batch_delete operationId: Contact_removeBatch description: Removes Contacts with given list of ids parameters: - description: >- Specify validation level of Contacts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8xg2m3pfwdoh2 /entities/Contacts/batch-modify: post: tags: - Contact summary: Contacts.batch_create_or_update operationId: Contact_batchCreateOrUpdate description: Create or update an batch of Contacts parameters: - description: >- Specify validation level of Contacts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Contact required: true content: application / json: schema: $ref: '#/components/schemas/ContactBatchCreateOrUpdateRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Contacts content: application/json: schema: $ref: '#/components/schemas/ContactBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a2bhuq7r4akwy /entities/ContactAccountAccountRoleRelations/{id}: get: tags: - Contact summary: ContactAccountAccountRoleRelations.get operationId: Contact_getById description: Returns ContactAccountAccountRoleRelation with given id parameters: - description: ID of ContactAccountAccountRoleRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactAccountAccountRoleRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kabinw9j0rc36 delete: tags: - Contact summary: ContactAccountAccountRoleRelations.delete operationId: Contact_removeById description: Removes ContactAccountAccountRoleRelation with given id parameters: - description: ID of ContactAccountAccountRoleRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3rz7fyqxnyw1w patch: tags: - Contact summary: ContactAccountAccountRoleRelations.update operationId: Contact_updateRelation description: >- Modifies ContactAccountAccountRoleRelation or ContactAccountAccountRoleRelations with given id(s) parameters: - description: ID of ContactAccountAccountRoleRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateContactAccountAccountRoleRelationInput responses: '200': description: >- Modification confirmation. Returns resulting ContactAccountAccountRoleRelation content: application/json: schema: $ref: '#/components/schemas/ContactUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 26s0uzn15n8lb /entities/ContactAccountAccountRoleRelations: get: tags: - Contact summary: ContactAccountAccountRoleRelations.list operationId: Contact_listRelations description: Returns all defined ContactAccountAccountRoleRelations parameters: - description: >- if enabled, deleted ContactAccountAccountRoleRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactAccountAccountRoleRelations content: application/json: schema: $ref: '#/components/schemas/ContactListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oo493u2iwb748 post: tags: - Contact summary: ContactAccountAccountRoleRelations.create operationId: Contact_createRelation description: Creates new ContactAccountAccountRoleRelation parameters: - description: >- Specify validation level of ContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createContactAccountAccountRoleRelationInput responses: '201': description: >- Creation confirmation. Returns created ContactAccountAccountRoleRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sqv2babsnqx30 /entities/ContactAccountAccountRoleRelations/batch-delete: post: tags: - Contact summary: ContactAccountAccountRoleRelations.batch_delete operationId: Contact_removeBatch description: Removes ContactAccountAccountRoleRelations with given list of ids parameters: - description: >- Specify validation level of ContactAccountAccountRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a5i8tadvsodpy /entities/ContactAccountAccountRoleRelations/batch-modify: post: tags: - Contact summary: ContactAccountAccountRoleRelations.batch_create_or_update operationId: Contact_updateBatch description: Create or update an batch of ContactAccountAccountRoleRelations parameters: - description: >- Specify validation level of ContactAccountAccountRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactAccountAccountRoleRelations content: application/json: schema: $ref: '#/components/schemas/ContactUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1x7sxxidshx5u /entities/ContactAccountRelations/{id}: get: tags: - Contact summary: ContactAccountRelations.get operationId: Contact_getById description: Returns ContactAccountRelation with given id parameters: - description: ID of ContactAccountRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactAccountRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e97m6bigrjob6 delete: tags: - Contact summary: ContactAccountRelations.delete operationId: Contact_removeById description: Removes ContactAccountRelation with given id parameters: - description: ID of ContactAccountRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2owrumqdd0hs6 patch: tags: - Contact summary: ContactAccountRelations.update operationId: Contact_modifyRelation description: >- Modifies ContactAccountRelation or ContactAccountRelations with given id(s) parameters: - description: ID of ContactAccountRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactAccountRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2ags21qilly68 /entities/ContactAccountRelations: get: tags: - Contact summary: ContactAccountRelations.list operationId: Contact_getAllContactAccountRelations description: Returns all defined ContactAccountRelations parameters: - description: if enabled, deleted ContactAccountRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactAccountRelations content: application/json: schema: $ref: >- #/components/schemas/ContactGetAllContactAccountRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3pi470dmzt1cd post: tags: - Contact summary: ContactAccountRelations.create operationId: Contact_createRelation description: Creates new ContactAccountRelation parameters: - description: >- Specify validation level of ContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactAccountRelationInput' responses: '201': description: Creation confirmation. Returns created ContactAccountRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kjq5h9xv23swj /entities/ContactAccountRelations/batch-delete: post: tags: - Contact summary: ContactAccountRelations.batch_delete operationId: Contact_removeBatchRelations description: Removes ContactAccountRelations with given list of ids parameters: - description: >- Specify validation level of ContactAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7lawasfav5al7 /entities/ContactAccountRelations/batch-modify: post: tags: - Contact summary: ContactAccountRelations.batch_create_or_update operationId: Contact_modifyBatchRelations description: Create or update an batch of ContactAccountRelations parameters: - description: >- Specify validation level of ContactAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactAccountRelations content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w2c6ribpycfhj /entities/ContactDataExRelations/{id}: get: tags: - Contact summary: ContactDataExRelations.get operationId: Contact_getById description: Returns ContactDataExRelation with given id parameters: - description: ID of ContactDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactDataExRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 25tfsjw4il4y2 /entities/ContactDataExRelations: get: tags: - Contact summary: ContactDataExRelations.list operationId: Contact_getAllRelations description: Returns all defined ContactDataExRelations parameters: - description: if enabled, deleted ContactDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactDataExRelations content: application/json: schema: $ref: '#/components/schemas/ContactGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9midy38gepwct /entities/ContactKPIs/{id}: get: tags: - Contact summary: ContactKPIs.get operationId: Contact_getById description: Returns ContactKPI with given id parameters: - description: ID of ContactKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactKPI data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: srbmncj30ndsg delete: tags: - Contact summary: ContactKPIs.delete operationId: Contact_removeById description: Removes ContactKPI with given id parameters: - description: ID of ContactKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactKPI 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ozztwx0q6a3h3 patch: tags: - Contact summary: ContactKPIs.update operationId: Contact_modifyKPIById description: Modifies ContactKPI or ContactKPIs with given id(s) parameters: - description: ID of ContactKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactKPIInput' responses: '200': description: Modification confirmation. Returns resulting ContactKPI content: application/json: schema: $ref: '#/components/schemas/ContactModifyKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ykgw3dfiwoivs /entities/ContactKPIs: get: tags: - Contact summary: ContactKPIs.list operationId: Contact_getAllKpis description: Returns all defined ContactKPIs parameters: - description: if enabled, deleted ContactKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactKPIs content: application/json: schema: $ref: '#/components/schemas/ContactGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z2tka3wfjjyle post: tags: - Contact summary: ContactKPIs.create operationId: Contact_createNewKPI description: Creates new ContactKPI parameters: - description: >- Specify validation level of ContactKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactKPI required: true content: application / json: schema: $ref: '#/components/schemas/createContactKPIInput' responses: '201': description: Creation confirmation. Returns created ContactKPI content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewKpiResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nt8kghgfupizn /entities/ContactKPIs/batch-delete: post: tags: - Contact summary: ContactKPIs.batch_delete operationId: Contact_removeBatchByIds description: Removes ContactKPIs with given list of ids parameters: - description: >- Specify validation level of ContactKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: glu5e4efd981w /entities/ContactKPIs/batch-modify: post: tags: - Contact summary: ContactKPIs.batch_create_or_update operationId: Contact_createOrUpdateBatch description: Create or update an batch of ContactKPIs parameters: - description: >- Specify validation level of ContactKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactKPI required: true content: application / json: schema: $ref: '#/components/schemas/ContactCreateOrUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactKPIs content: application/json: schema: $ref: '#/components/schemas/ContactCreateOrUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6extiomk9w2qw /entities/ContactRelations/{id}: get: tags: - Contact summary: ContactRelations.get operationId: Contact_getById description: Returns ContactRelation with given id parameters: - description: ID of ContactRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: witvsysd9qran delete: tags: - Contact summary: ContactRelations.delete operationId: Contact_removeById description: Removes ContactRelation with given id parameters: - description: ID of ContactRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pi93u98ej84um patch: tags: - Contact summary: ContactRelations.update operationId: Contact_modifyById description: Modifies ContactRelation or ContactRelations with given id(s) parameters: - description: ID of ContactRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 97wv2byku08fp /entities/ContactRelations: get: tags: - Contact summary: ContactRelations.list operationId: Contact_getAllDefinedContactRelations description: Returns all defined ContactRelations parameters: - description: if enabled, deleted ContactRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactRelations content: application/json: schema: $ref: >- #/components/schemas/ContactGetAllDefinedContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p39ew49vs5ye2 post: tags: - Contact summary: ContactRelations.create operationId: Contact_createNewContactRelation description: Creates new ContactRelation parameters: - description: >- Specify validation level of ContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationInput' responses: '201': description: Creation confirmation. Returns created ContactRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewContactRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4940kbq2gw3mp /entities/ContactRelations/batch-delete: post: tags: - Contact summary: ContactRelations.batch_delete operationId: Contact_removeBatch description: Removes ContactRelations with given list of ids parameters: - description: >- Specify validation level of ContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aoex9qdbund58 /entities/ContactRelations/batch-modify: post: tags: - Contact summary: ContactRelations.batch_create_or_update operationId: Contact_modifyBatchRelations description: Create or update an batch of ContactRelations parameters: - description: >- Specify validation level of ContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchRelationsRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactRelations content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchRelations200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: amnw4syo68hz9 /entities/ContactRelationLabels/{id}: get: tags: - Contact summary: ContactRelationLabels.get operationId: Contact_getById description: Returns ContactRelationLabel with given id parameters: - description: ID of ContactRelationLabel to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactRelationLabel data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p9mihmemmyibb delete: tags: - Contact summary: ContactRelationLabels.delete operationId: Contact_removeById description: Removes ContactRelationLabel with given id parameters: - description: ID of ContactRelationLabel to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1u3t7jc183pld patch: tags: - Contact summary: ContactRelationLabels.update operationId: Contact_modifyLabel description: Modifies ContactRelationLabel or ContactRelationLabels with given id(s) parameters: - description: ID of ContactRelationLabel to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationLabelInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelationLabel content: application/json: schema: $ref: '#/components/schemas/ContactModifyLabelResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ruakiev11lt9t /entities/ContactRelationLabels: get: tags: - Contact summary: ContactRelationLabels.list operationId: Contact_getAllLabels description: Returns all defined ContactRelationLabels parameters: - description: if enabled, deleted ContactRelationLabels are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactRelationLabels content: application/json: schema: $ref: '#/components/schemas/ContactGetAllLabelsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ag69fa00huey5 post: tags: - Contact summary: ContactRelationLabels.create operationId: Contact_createLabel description: Creates new ContactRelationLabel parameters: - description: >- Specify validation level of ContactRelationLabel 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationLabelInput' responses: '201': description: Creation confirmation. Returns created ContactRelationLabel content: application/json: schema: $ref: '#/components/schemas/ContactCreateLabelResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8k6wgsons00k6 /entities/ContactRelationLabels/batch-delete: post: tags: - Contact summary: ContactRelationLabels.batch_delete operationId: Contact_removeBatchByIds description: Removes ContactRelationLabels with given list of ids parameters: - description: >- Specify validation level of ContactRelationLabels 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nq2tnk45gs3eq /entities/ContactRelationLabels/batch-modify: post: tags: - Contact summary: ContactRelationLabels.batch_create_or_update operationId: Contact_modifyBatchLabels description: Create or update an batch of ContactRelationLabels parameters: - description: >- Specify validation level of ContactRelationLabels 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchLabelsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactRelationLabels content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchLabelsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: t3gdpn66fb2li /entities/ContactRelationTypes/{id}: get: tags: - Contact summary: ContactRelationTypes.get operationId: Contact_getById description: Returns ContactRelationType with given id parameters: - description: ID of ContactRelationType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactRelationType data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g2ijx2n8gigq0 delete: tags: - Contact summary: ContactRelationTypes.delete operationId: Contact_removeById description: Removes ContactRelationType with given id parameters: - description: ID of ContactRelationType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelationType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4c53uzid7wx0y patch: tags: - Contact summary: ContactRelationTypes.update operationId: Contact_modifyByIds description: Modifies ContactRelationType or ContactRelationTypes with given id(s) parameters: - description: ID of ContactRelationType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelationType content: application/json: schema: $ref: '#/components/schemas/ContactModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l346uv398i48v /entities/ContactRelationTypes: get: tags: - Contact summary: ContactRelationTypes.list operationId: Contact_getAllContactRelationTypes description: Returns all defined ContactRelationTypes parameters: - description: if enabled, deleted ContactRelationTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactRelationTypes content: application/json: schema: $ref: '#/components/schemas/ContactGetAllContactRelationTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mbzyet1thw7lp post: tags: - Contact summary: ContactRelationTypes.create operationId: Contact_createNew description: Creates new ContactRelationType parameters: - description: >- Specify validation level of ContactRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationTypeInput' responses: '201': description: Creation confirmation. Returns created ContactRelationType content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: joluvb6hvemac /entities/ContactRelationTypes/batch-delete: post: tags: - Contact summary: ContactRelationTypes.batch_delete operationId: Contact_removeBatchByIds description: Removes ContactRelationTypes with given list of ids parameters: - description: >- Specify validation level of ContactRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIdsRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIds200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: anum68yp1w833 /entities/ContactRelationTypes/batch-modify: post: tags: - Contact summary: ContactRelationTypes.batch_create_or_update operationId: Contact_modifyBatchContactRelationTypes description: Create or update an batch of ContactRelationTypes parameters: - description: >- Specify validation level of ContactRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactRelationType required: true content: application / json: schema: $ref: >- #/components/schemas/ContactModifyBatchContactRelationTypesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactRelationTypes content: application/json: schema: $ref: >- #/components/schemas/ContactModifyBatchContactRelationTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fefj7zklt9b2r /entities/ContactSharingClientRelations/{id}: get: tags: - Contact summary: ContactSharingClientRelations.get operationId: Contact_getById description: Returns ContactSharingClientRelation with given id parameters: - description: ID of ContactSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7oa3qb39i613w delete: tags: - Contact summary: ContactSharingClientRelations.delete operationId: Contact_removeById description: Removes ContactSharingClientRelation with given id parameters: - description: ID of ContactSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1zxz7fikhnvel patch: tags: - Contact summary: ContactSharingClientRelations.update operationId: Contact_modifyRelation description: >- Modifies ContactSharingClientRelation or ContactSharingClientRelations with given id(s) parameters: - description: ID of ContactSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting ContactSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vuinkcy43ck31 /entities/ContactSharingClientRelations: get: tags: - Contact summary: ContactSharingClientRelations.list operationId: Contact_getAllClientRelations description: Returns all defined ContactSharingClientRelations parameters: - description: >- if enabled, deleted ContactSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/ContactGetAllClientRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vj5y3pzqa2gbv post: tags: - Contact summary: ContactSharingClientRelations.create operationId: Contact_createRelation description: Creates new ContactSharingClientRelation parameters: - description: >- Specify validation level of ContactSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created ContactSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateRelation201Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o81b4yov2wy64 /entities/ContactSharingClientRelations/batch-delete: post: tags: - Contact summary: ContactSharingClientRelations.batch_delete operationId: Contact_removeBatch description: Removes ContactSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of ContactSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatch200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2jptyj1x0ixht /entities/ContactSharingClientRelations/batch-modify: post: tags: - Contact summary: ContactSharingClientRelations.batch_create_or_update operationId: Contact_modifyBatchContactRelations description: Create or update an batch of ContactSharingClientRelations parameters: - description: >- Specify validation level of ContactSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchContactRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/ContactModifyBatchContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 77g0iowxqggay /entities/ContactSharingSalesUnitRelations/{id}: get: tags: - Contact summary: ContactSharingSalesUnitRelations.get operationId: Contact_getById description: Returns ContactSharingSalesUnitRelation with given id parameters: - description: ID of ContactSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: we5ueergz48s3 delete: tags: - Contact summary: ContactSharingSalesUnitRelations.delete operationId: Contact_removeById description: Removes ContactSharingSalesUnitRelation with given id parameters: - description: ID of ContactSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gh6mpwfxr31ax patch: tags: - Contact summary: ContactSharingSalesUnitRelations.update operationId: Contact_updateById description: >- Modifies ContactSharingSalesUnitRelation or ContactSharingSalesUnitRelations with given id(s) parameters: - description: ID of ContactSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting ContactSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/ContactUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vs48pe8rf1jba /entities/ContactSharingSalesUnitRelations: get: tags: - Contact summary: ContactSharingSalesUnitRelations.list operationId: Contact_listRelations description: Returns all defined ContactSharingSalesUnitRelations parameters: - description: >- if enabled, deleted ContactSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ContactListRelations200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r5w6qkjdriy8a post: tags: - Contact summary: ContactSharingSalesUnitRelations.create operationId: Contact_createRelation description: Creates new ContactSharingSalesUnitRelation parameters: - description: >- Specify validation level of ContactSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSharingSalesUnitRelationInput' responses: '201': description: >- Creation confirmation. Returns created ContactSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateRelation201Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lvgkp4svg8z0y /entities/ContactSharingSalesUnitRelations/batch-delete: post: tags: - Contact summary: ContactSharingSalesUnitRelations.batch_delete operationId: Contact_removeBatchByIds description: Removes ContactSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of ContactSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIdsRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchByIds200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8qrbox7w7vol1 /entities/ContactSharingSalesUnitRelations/batch-modify: post: tags: - Contact summary: ContactSharingSalesUnitRelations.batch_create_or_update operationId: Contact_updateBatch description: Create or update an batch of ContactSharingSalesUnitRelations parameters: - description: >- Specify validation level of ContactSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactUpdateBatchRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ContactUpdateBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oc909sqbhsfuk /entities/ContactSocialRelations/{id}: get: tags: - Contact summary: ContactSocialRelations.get operationId: Contact_getById description: Returns ContactSocialRelation with given id parameters: - description: ID of ContactSocialRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactSocialRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 80jq53p8z0smb delete: tags: - Contact summary: ContactSocialRelations.delete operationId: Contact_removeById description: Removes ContactSocialRelation with given id parameters: - description: ID of ContactSocialRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 752j12ovn1jyf patch: tags: - Contact summary: ContactSocialRelations.update operationId: Contact_modifySocialRelation description: >- Modifies ContactSocialRelation or ContactSocialRelations with given id(s) parameters: - description: ID of ContactSocialRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSocialRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactSocialRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifySocialRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ku6p31rh31b67 /entities/ContactSocialRelations: get: tags: - Contact summary: ContactSocialRelations.list operationId: Contact_getAllSocialRelations description: Returns all defined ContactSocialRelations parameters: - description: if enabled, deleted ContactSocialRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactSocialRelations content: application/json: schema: $ref: '#/components/schemas/ContactGetAllSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s2479hr0hvh2f post: tags: - Contact summary: ContactSocialRelations.create operationId: Contact_createNewSocialRelation description: Creates new ContactSocialRelation parameters: - description: >- Specify validation level of ContactSocialRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSocialRelationInput' responses: '201': description: Creation confirmation. Returns created ContactSocialRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewSocialRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7nfockh42aw5y /entities/ContactSocialRelations/batch-delete: post: tags: - Contact summary: ContactSocialRelations.batch_delete operationId: Contact_removeBatchSocialRelations description: Removes ContactSocialRelations with given list of ids parameters: - description: >- Specify validation level of ContactSocialRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchSocialRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatchSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tsi4uhqlsm7r1 /entities/ContactSocialRelations/batch-modify: post: tags: - Contact summary: ContactSocialRelations.batch_create_or_update operationId: Contact_modifyBatchSocialRelations description: Create or update an batch of ContactSocialRelations parameters: - description: >- Specify validation level of ContactSocialRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchSocialRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactSocialRelations content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchSocialRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8p8haqyf84deb /entities/ContactTypes/{id}: get: tags: - Contact summary: ContactTypes.get operationId: Contact_getById description: Returns ContactType with given id parameters: - description: ID of ContactType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ContactType data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oab0dtpfcysqb delete: tags: - Contact summary: ContactTypes.delete operationId: Contact_removeById description: Removes ContactType with given id parameters: - description: ID of ContactType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9jrq9jrdm4g99 patch: tags: - Contact summary: ContactTypes.update operationId: Contact_modifyById description: Modifies ContactType or ContactTypes with given id(s) parameters: - description: ID of ContactType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ContactType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactTypeInput' responses: '200': description: Modification confirmation. Returns resulting ContactType content: application/json: schema: $ref: '#/components/schemas/ContactModifyById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f51ifsm15mdyz /entities/ContactTypes: get: tags: - Contact summary: ContactTypes.list operationId: Contact_getAllTypes description: Returns all defined ContactTypes parameters: - description: if enabled, deleted ContactTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ContactTypes content: application/json: schema: $ref: '#/components/schemas/ContactGetAllTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: adwhkicvvezrk post: tags: - Contact summary: ContactTypes.create operationId: Contact_createNewType description: Creates new ContactType parameters: - description: >- Specify validation level of ContactType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ContactType required: true content: application / json: schema: $ref: '#/components/schemas/createContactTypeInput' responses: '201': description: Creation confirmation. Returns created ContactType content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hhztoavdzy05m /entities/ContactTypes/batch-delete: post: tags: - Contact summary: ContactTypes.batch_delete operationId: Contact_removeByIds description: Removes ContactTypes with given list of ids parameters: - description: >- Specify validation level of ContactTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 77keblqknzo8g /entities/ContactTypes/batch-modify: post: tags: - Contact summary: ContactTypes.batch_create_or_update operationId: Contact_modifyBatchContactTypes description: Create or update an batch of ContactTypes parameters: - description: >- Specify validation level of ContactTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ContactType required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchContactTypesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ContactTypes content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchContactTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4me6bjhcxox1e /entities/Currencies/{id}: get: tags: - Currency summary: Currencies.get operationId: Currency_getById description: Returns Currency with given id parameters: - description: ID of Currency to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Currency data content: application/json: schema: $ref: '#/components/schemas/CurrencyGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ecqwli7ex4xoj delete: tags: - Currency summary: Currencies.delete operationId: Currency_removeById description: Removes Currency with given id parameters: - description: ID of Currency to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Currency 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 54cojmrtf16o6 patch: tags: - Currency summary: Currencies.update operationId: Currency_modifyById description: Modifies Currency or Currencies with given id(s) parameters: - description: ID of Currency to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Currency 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCurrencyInput' responses: '200': description: Modification confirmation. Returns resulting Currency content: application/json: schema: $ref: '#/components/schemas/CurrencyModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jte8mw5c89iw6 /entities/Currencies: get: tags: - Currency summary: Currencies.list operationId: Currency_getAllCurrencies description: Returns all defined Currencies parameters: - description: if enabled, deleted Currencies are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Currencies content: application/json: schema: $ref: '#/components/schemas/CurrencyGetAllCurrenciesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6cb78384vq9ku post: tags: - Currency summary: Currencies.create operationId: Currency_createNewCurrency description: Creates new Currency parameters: - description: >- Specify validation level of Currency 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Currency required: true content: application / json: schema: $ref: '#/components/schemas/createCurrencyInput' responses: '201': description: Creation confirmation. Returns created Currency content: application/json: schema: $ref: '#/components/schemas/CurrencyCreateNewCurrencyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nhq8c7gf5qmxg /entities/Currencies/batch-delete: post: tags: - Currency summary: Currencies.batch_delete operationId: Currency_removeById description: Removes Currencies with given list of ids parameters: - description: >- Specify validation level of Currencies 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Currencies. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyRemoveByIdRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveById200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rp506dtjovnq6 /entities/Currencies/batch-modify: post: tags: - Currency summary: Currencies.batch_create_or_update operationId: Currency_batchModify description: Create or update an batch of Currencies parameters: - description: >- Specify validation level of Currencies 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Currencies. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Currency required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated Currencies content: application/json: schema: $ref: '#/components/schemas/CurrencyBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v199hqgzdzjof /entities/CurrencyExchangeRates/{id}: get: tags: - Currency summary: CurrencyExchangeRates.get operationId: Currency_getById description: Returns CurrencyExchangeRate with given id parameters: - description: ID of CurrencyExchangeRate to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CurrencyExchangeRate data content: application/json: schema: $ref: '#/components/schemas/CurrencyGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jxrxhnf2152oi delete: tags: - Currency summary: CurrencyExchangeRates.delete operationId: Currency_removeById description: Removes CurrencyExchangeRate with given id parameters: - description: ID of CurrencyExchangeRate to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CurrencyExchangeRate 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fxz3x5ej15eee patch: tags: - Currency summary: CurrencyExchangeRates.update operationId: Currency_modifyExchangeRate description: Modifies CurrencyExchangeRate or CurrencyExchangeRates with given id(s) parameters: - description: ID of CurrencyExchangeRate to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CurrencyExchangeRate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCurrencyExchangeRateInput' responses: '200': description: Modification confirmation. Returns resulting CurrencyExchangeRate content: application/json: schema: $ref: '#/components/schemas/CurrencyModifyExchangeRateResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: djl92o2unjnod /entities/CurrencyExchangeRates: get: tags: - Currency summary: CurrencyExchangeRates.list operationId: Currency_getAllRates description: Returns all defined CurrencyExchangeRates parameters: - description: if enabled, deleted CurrencyExchangeRates are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CurrencyExchangeRates content: application/json: schema: $ref: '#/components/schemas/CurrencyGetAllRatesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: elek18hcgnix1 post: tags: - Currency summary: CurrencyExchangeRates.create operationId: Currency_createExchangeRate description: Creates new CurrencyExchangeRate parameters: - description: >- Specify validation level of CurrencyExchangeRate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CurrencyExchangeRate required: true content: application / json: schema: $ref: '#/components/schemas/createCurrencyExchangeRateInput' responses: '201': description: Creation confirmation. Returns created CurrencyExchangeRate content: application/json: schema: $ref: '#/components/schemas/CurrencyCreateExchangeRateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: le32btxzclod0 /entities/CurrencyExchangeRates/batch-delete: post: tags: - Currency summary: CurrencyExchangeRates.batch_delete operationId: Currency_removeByIds description: Removes CurrencyExchangeRates with given list of ids parameters: - description: >- Specify validation level of CurrencyExchangeRates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CurrencyExchangeRates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hxmm3nbu1nf78 /entities/CurrencyExchangeRates/batch-modify: post: tags: - Currency summary: CurrencyExchangeRates.batch_create_or_update operationId: Currency_exchangeRatesBatchModify description: Create or update an batch of CurrencyExchangeRates parameters: - description: >- Specify validation level of CurrencyExchangeRates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CurrencyExchangeRates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CurrencyExchangeRate required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyExchangeRatesBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated CurrencyExchangeRates content: application/json: schema: $ref: '#/components/schemas/CurrencyExchangeRatesBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vcqhyu6exmt2n /entities/CurrencyExchangeRatesLists/{id}: get: tags: - Currency summary: CurrencyExchangeRatesLists.get operationId: Currency_getById description: Returns CurrencyExchangeRatesList with given id parameters: - description: ID of CurrencyExchangeRatesList to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CurrencyExchangeRatesList data content: application/json: schema: $ref: '#/components/schemas/CurrencyGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cdp9it6k6imge delete: tags: - Currency summary: CurrencyExchangeRatesLists.delete operationId: Currency_removeById description: Removes CurrencyExchangeRatesList with given id parameters: - description: ID of CurrencyExchangeRatesList to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CurrencyExchangeRatesList 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4zlb80o37dnol patch: tags: - Currency summary: CurrencyExchangeRatesLists.update operationId: Currency_updateExchangeRatesList description: >- Modifies CurrencyExchangeRatesList or CurrencyExchangeRatesLists with given id(s) parameters: - description: ID of CurrencyExchangeRatesList to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CurrencyExchangeRatesList 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCurrencyExchangeRatesListInput' responses: '200': description: >- Modification confirmation. Returns resulting CurrencyExchangeRatesList content: application/json: schema: $ref: '#/components/schemas/CurrencyUpdateExchangeRatesListResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rvny0w68yg97n /entities/CurrencyExchangeRatesLists: get: tags: - Currency summary: CurrencyExchangeRatesLists.list operationId: Currency_getAllLists description: Returns all defined CurrencyExchangeRatesLists parameters: - description: if enabled, deleted CurrencyExchangeRatesLists are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CurrencyExchangeRatesLists content: application/json: schema: $ref: '#/components/schemas/CurrencyGetAllListsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2dah44edvqvbp post: tags: - Currency summary: CurrencyExchangeRatesLists.create operationId: Currency_createExchangeRatesList description: Creates new CurrencyExchangeRatesList parameters: - description: >- Specify validation level of CurrencyExchangeRatesList 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CurrencyExchangeRatesList required: true content: application / json: schema: $ref: '#/components/schemas/createCurrencyExchangeRatesListInput' responses: '201': description: Creation confirmation. Returns created CurrencyExchangeRatesList content: application/json: schema: $ref: '#/components/schemas/CurrencyCreateExchangeRatesListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p3qd3uwpqmmsd /entities/CurrencyExchangeRatesLists/batch-delete: post: tags: - Currency summary: CurrencyExchangeRatesLists.batch_delete operationId: Currency_removeList description: Removes CurrencyExchangeRatesLists with given list of ids parameters: - description: >- Specify validation level of CurrencyExchangeRatesLists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CurrencyExchangeRatesLists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyRemoveListRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CurrencyRemoveListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4jk8ozkv4zeyz /entities/CurrencyExchangeRatesLists/batch-modify: post: tags: - Currency summary: CurrencyExchangeRatesLists.batch_create_or_update operationId: Currency_exchangeRatesBatchModify description: Create or update an batch of CurrencyExchangeRatesLists parameters: - description: >- Specify validation level of CurrencyExchangeRatesLists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for CurrencyExchangeRatesLists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CurrencyExchangeRatesList required: true content: application / json: schema: $ref: '#/components/schemas/CurrencyExchangeRatesBatchModifyRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated CurrencyExchangeRatesLists content: application/json: schema: $ref: >- #/components/schemas/CurrencyExchangeRatesBatchModify200Response '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: efmv4loc8itud /entities/{custom_entity_api_name}/{id}: get: tags: - Custom Entity summary: CustomEntities.get operationId: CustomEntity_getById description: Returns CustomEntity with given id parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: ID of CustomEntity to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CustomEntity data content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 01nbgdkrzloaz delete: tags: - Custom Entity summary: CustomEntities.delete operationId: CustomEntity_removeById description: Removes CustomEntity with given id parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: ID of CustomEntity to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CustomEntity 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CustomEntityRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r72fkcpwd9yoi patch: tags: - Custom Entity summary: CustomEntities.update operationId: CustomEntity_modifyById description: Modifies CustomEntity or {custom_entity_api_name} with given id(s) parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: ID of CustomEntity to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CustomEntity 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCustomEntityInput' responses: '200': description: Modification confirmation. Returns resulting CustomEntity content: application/json: schema: $ref: '#/components/schemas/CustomEntityModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1ptcmoo1dkyff /entities/{custom_entity_api_name}: get: tags: - Custom Entity summary: CustomEntities.list operationId: CustomEntity_getAllEntities description: Returns all defined {custom_entity_api_name} parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: if enabled, deleted {custom_entity_api_name} are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of {custom_entity_api_name} content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetAllEntitiesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cv0mtsssv8yuq post: tags: - Custom Entity summary: CustomEntities.create operationId: CustomEntity_createNewCustomEntity description: Creates new CustomEntity parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: >- Specify validation level of CustomEntity 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CustomEntity required: true content: application / json: schema: $ref: '#/components/schemas/createCustomEntityInput' responses: '201': description: Creation confirmation. Returns created CustomEntity content: application/json: schema: $ref: '#/components/schemas/CustomEntityCreateNewCustomEntityResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jqds58uwqrg4r /entities/{custom_entity_api_name}/batch-delete: post: tags: - Custom Entity summary: CustomEntities.batch_delete operationId: CustomEntity_removeBatch description: Removes {custom_entity_api_name} with given list of ids parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: >- Specify validation level of {custom_entity_api_name} 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for {custom_entity_api_name}. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CustomEntityRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CustomEntityRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zd3mfpaf7kttb /entities/{custom_entity_api_name}/batch-modify: post: tags: - Custom Entity summary: CustomEntities.batch_create_or_update operationId: CustomEntity_batchModify description: Create or update an batch of {custom_entity_api_name} parameters: - description: Custom entity api name name: custom_entity_api_name in: path required: true schema: type: string - description: >- Specify validation level of {custom_entity_api_name} 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for {custom_entity_api_name}. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CustomEntity required: true content: application / json: schema: $ref: '#/components/schemas/CustomEntityBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated {custom_entity_api_name} content: application/json: schema: $ref: '#/components/schemas/CustomEntityBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jv7elcxg4o306 /entities/{custom_entity_type_api_name}/{id}: get: tags: - Custom Entity summary: CustomEntityTypes.get operationId: CustomEntity_getById description: Returns CustomEntityType with given id parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: ID of CustomEntityType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: CustomEntityType data content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cs9zzilzml8zz delete: tags: - Custom Entity summary: CustomEntityTypes.delete operationId: CustomEntity_removeById description: Removes CustomEntityType with given id parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: ID of CustomEntityType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CustomEntityType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/CustomEntityRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fc3ywyzp69miq patch: tags: - Custom Entity summary: CustomEntityTypes.update operationId: CustomEntity_updateById description: >- Modifies CustomEntityType or {custom_entity_type_api_name} with given id(s) parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: ID of CustomEntityType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of CustomEntityType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCustomEntityTypeInput' responses: '200': description: Modification confirmation. Returns resulting CustomEntityType content: application/json: schema: $ref: '#/components/schemas/CustomEntityUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 48ule255apll2 /entities/{custom_entity_type_api_name}: get: tags: - Custom Entity summary: CustomEntityTypes.list operationId: CustomEntity_getAll description: Returns all defined {custom_entity_type_api_name} parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: >- if enabled, deleted {custom_entity_type_api_name} are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of {custom_entity_type_api_name} content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0315nqnkxf826 post: tags: - Custom Entity summary: CustomEntityTypes.create operationId: CustomEntity_createNew description: Creates new CustomEntityType parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: >- Specify validation level of CustomEntityType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new CustomEntityType required: true content: application / json: schema: $ref: '#/components/schemas/createCustomEntityTypeInput' responses: '201': description: Creation confirmation. Returns created CustomEntityType content: application/json: schema: $ref: '#/components/schemas/CustomEntityCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fugn0nqsft9jm /entities/{custom_entity_type_api_name}/batch-delete: post: tags: - Custom Entity summary: CustomEntityTypes.batch_delete operationId: CustomEntity_removeBatch description: Removes {custom_entity_type_api_name} with given list of ids parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: >- Specify validation level of {custom_entity_type_api_name} 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for {custom_entity_type_api_name}. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/CustomEntityRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/CustomEntityRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: okeb27rhe3bqv /entities/{custom_entity_type_api_name}/batch-modify: post: tags: - Custom Entity summary: CustomEntityTypes.batch_create_or_update operationId: CustomEntity_batchModify description: Create or update an batch of {custom_entity_type_api_name} parameters: - description: Custom entity type api name name: custom_entity_type_api_name in: path required: true schema: type: string - description: >- Specify validation level of {custom_entity_type_api_name} 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for {custom_entity_type_api_name}. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new CustomEntityType required: true content: application / json: schema: $ref: '#/components/schemas/CustomEntityBatchModifyRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated {custom_entity_type_api_name} content: application/json: schema: $ref: '#/components/schemas/CustomEntityBatchModify200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yj2fq6q1wcml8 /entities/Data/{id}: get: tags: - Data summary: Data.get operationId: Data_getById description: Returns Data with given id parameters: - description: ID of Data to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Data data content: application/json: schema: $ref: '#/components/schemas/DataGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: khx92etvx2vjh delete: tags: - Data summary: Data.delete operationId: Data_removeById description: Removes Data with given id parameters: - description: ID of Data to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Data 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DataRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ic1hime3e6u6v patch: tags: - Data summary: Data.update operationId: Data_modifyById description: Modifies Data or Data with given id(s) parameters: - description: ID of Data to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Data 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateDataInput' responses: '200': description: Modification confirmation. Returns resulting Data content: application/json: schema: $ref: '#/components/schemas/DataModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 76ly8i1m6gd11 /entities/Data: get: tags: - Data summary: Data.list operationId: Data_getAll description: Returns all defined Data parameters: - description: if enabled, deleted Data are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Data content: application/json: schema: $ref: '#/components/schemas/DataGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hwlotcb0uiqnf post: tags: - Data summary: Data.create operationId: Data_addNew description: Creates new Data parameters: - description: >- Specify validation level of Data 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Data required: true content: application / json: schema: $ref: '#/components/schemas/createDataInput' responses: '201': description: Creation confirmation. Returns created Data content: application/json: schema: $ref: '#/components/schemas/DataAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fhkpzdsvk2y49 /entities/Data/batch-delete: post: tags: - Data summary: Data.batch_delete operationId: Data_removeByIdBatch description: Removes Data with given list of ids parameters: - description: >- Specify validation level of Data 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Data. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DataRemoveByIdBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DataRemoveByIdBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0y5l15o5059k7 /entities/Data/batch-modify: post: tags: - Data summary: Data.batch_create_or_update operationId: Data_modifyBatch description: Create or update an batch of Data parameters: - description: >- Specify validation level of Data 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Data. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Data required: true content: application / json: schema: $ref: '#/components/schemas/DataModifyBatchRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Data content: application/json: schema: $ref: '#/components/schemas/DataModifyBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d2h7za5wmgmpx /entities/DataRelations/{id}: get: tags: - Data summary: DataRelations.get operationId: Data_getById description: Returns DataRelation with given id parameters: - description: ID of DataRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: DataRelation data content: application/json: schema: $ref: '#/components/schemas/DataGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nn91om4qgvak2 delete: tags: - Data summary: DataRelations.delete operationId: Data_removeById description: Removes DataRelation with given id parameters: - description: ID of DataRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of DataRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/DataRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mto4a2qkhydj9 patch: tags: - Data summary: DataRelations.update operationId: Data_modifyById description: Modifies DataRelation or DataRelations with given id(s) parameters: - description: ID of DataRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of DataRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateDataRelationInput' responses: '200': description: Modification confirmation. Returns resulting DataRelation content: application/json: schema: $ref: '#/components/schemas/DataModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: renu4wypm9kh3 /entities/DataRelations: get: tags: - Data summary: DataRelations.list operationId: Data_getAllDataRelations description: Returns all defined DataRelations parameters: - description: if enabled, deleted DataRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of DataRelations content: application/json: schema: $ref: '#/components/schemas/DataGetAllDataRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uh4392ebahl6d post: tags: - Data summary: DataRelations.create operationId: Data_createRelation description: Creates new DataRelation parameters: - description: >- Specify validation level of DataRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new DataRelation required: true content: application / json: schema: $ref: '#/components/schemas/createDataRelationInput' responses: '201': description: Creation confirmation. Returns created DataRelation content: application/json: schema: $ref: '#/components/schemas/DataCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g5m5y8l78xf4r /entities/DataRelations/batch-delete: post: tags: - Data summary: DataRelations.batch_delete operationId: Data_removeByIds description: Removes DataRelations with given list of ids parameters: - description: >- Specify validation level of DataRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for DataRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/DataRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/DataRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nh5l5bqgg4hfk /entities/DataRelations/batch-modify: post: tags: - Data summary: DataRelations.batch_create_or_update operationId: Data_modifyBatch description: Create or update an batch of DataRelations parameters: - description: >- Specify validation level of DataRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for DataRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new DataRelation required: true content: application / json: schema: $ref: '#/components/schemas/DataModifyBatchRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated DataRelations content: application/json: schema: $ref: '#/components/schemas/DataModifyBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jxb4urfexq7b2 /entities/Emails/{id}: get: tags: - Email summary: Emails.get operationId: Email_getById description: Returns Email with given id parameters: - description: ID of Email to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Email data content: application/json: schema: $ref: '#/components/schemas/EmailGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6h8waq4rggdjh delete: tags: - Email summary: Emails.delete operationId: Email_removeById description: Removes Email with given id parameters: - description: ID of Email to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Email on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l1d9h30gk76v5 patch: tags: - Email summary: Emails.update operationId: Email_modifyById description: Modifies Email or Emails with given id(s) parameters: - description: ID of Email to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Email on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailInput' responses: '200': description: Modification confirmation. Returns resulting Email content: application/json: schema: $ref: '#/components/schemas/EmailModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: imopcs4jq10mn /entities/Emails: get: tags: - Email summary: Emails.list operationId: Email_getAllDefined description: Returns all defined Emails parameters: - description: if enabled, deleted Emails are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Emails content: application/json: schema: $ref: '#/components/schemas/EmailGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wd2gdtxpda9yv post: tags: - Email summary: Emails.create operationId: Email_createNew description: Creates new Email parameters: - description: >- Specify validation level of Email on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Email required: true content: application / json: schema: $ref: '#/components/schemas/createEmailInput' responses: '201': description: Creation confirmation. Returns created Email content: application/json: schema: $ref: '#/components/schemas/EmailCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: psrttpqwzovyh /entities/Emails/batch-delete: post: tags: - Email summary: Emails.batch_delete operationId: Email_removeBatch description: Removes Emails with given list of ids parameters: - description: >- Specify validation level of Emails on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Emails. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8n0hyht59ep3p /entities/Emails/batch-modify: post: tags: - Email summary: Emails.batch_create_or_update operationId: Email_batchModify description: Create or update an batch of Emails parameters: - description: >- Specify validation level of Emails on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Emails. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Email required: true content: application / json: schema: $ref: '#/components/schemas/EmailBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Emails content: application/json: schema: $ref: '#/components/schemas/EmailBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dlon5lthf9xd6 /entities/EmailContentSharingClientRelations/{id}: get: tags: - Email summary: EmailContentSharingClientRelations.get operationId: Email_getContentSharingClientRelation description: Returns EmailContentSharingClientRelation with given id parameters: - description: ID of EmailContentSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailContentSharingClientRelation data content: application/json: schema: $ref: >- #/components/schemas/EmailGetContentSharingClientRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lgbojfcnlso4f delete: tags: - Email summary: EmailContentSharingClientRelations.delete operationId: Email_removeById description: Removes EmailContentSharingClientRelation with given id parameters: - description: ID of EmailContentSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailContentSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s2w40qgpvh590 patch: tags: - Email summary: EmailContentSharingClientRelations.update operationId: Email_updateContentSharingClientRelation description: >- Modifies EmailContentSharingClientRelation or EmailContentSharingClientRelations with given id(s) parameters: - description: ID of EmailContentSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailContentSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateEmailContentSharingClientRelationInput responses: '200': description: >- Modification confirmation. Returns resulting EmailContentSharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/EmailUpdateContentSharingClientRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6kn45q58bugef /entities/EmailContentSharingClientRelations: get: tags: - Email summary: EmailContentSharingClientRelations.list operationId: Email_listRelations description: Returns all defined EmailContentSharingClientRelations parameters: - description: >- if enabled, deleted EmailContentSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailContentSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/EmailListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1odx4vscbfduk post: tags: - Email summary: EmailContentSharingClientRelations.create operationId: Email_createNewEmailContentSharingClientRelation description: Creates new EmailContentSharingClientRelation parameters: - description: >- Specify validation level of EmailContentSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingClientRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createEmailContentSharingClientRelationInput responses: '201': description: >- Creation confirmation. Returns created EmailContentSharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/EmailCreateNewEmailContentSharingClientRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2vq1v8b2t1dsy /entities/EmailContentSharingClientRelations/batch-delete: post: tags: - Email summary: EmailContentSharingClientRelations.batch_delete operationId: Email_removeBatchContentRelations description: Removes EmailContentSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of EmailContentSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchContentRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatchContentRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cqzt13xg0mj5d /entities/EmailContentSharingClientRelations/batch-modify: post: tags: - Email summary: EmailContentSharingClientRelations.batch_create_or_update operationId: Email_batchCreateOrUpdate description: Create or update an batch of EmailContentSharingClientRelations parameters: - description: >- Specify validation level of EmailContentSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/EmailBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailContentSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/EmailBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 644o3cwcjvtvr /entities/EmailContentSharingSalesUnitRelations/{id}: get: tags: - Email summary: EmailContentSharingSalesUnitRelations.get operationId: Email_getContentSharingSalesUnitRelations description: Returns EmailContentSharingSalesUnitRelation with given id parameters: - description: ID of EmailContentSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailContentSharingSalesUnitRelation data content: application/json: schema: $ref: >- #/components/schemas/EmailGetContentSharingSalesUnitRelationsResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3uw712tfmq9x4 delete: tags: - Email summary: EmailContentSharingSalesUnitRelations.delete operationId: Email_removeById description: Removes EmailContentSharingSalesUnitRelation with given id parameters: - description: ID of EmailContentSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailContentSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ihjys2nc28ho3 patch: tags: - Email summary: EmailContentSharingSalesUnitRelations.update operationId: Email_modifyContentSharingSalesUnitRelation description: >- Modifies EmailContentSharingSalesUnitRelation or EmailContentSharingSalesUnitRelations with given id(s) parameters: - description: ID of EmailContentSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailContentSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateEmailContentSharingSalesUnitRelationInput responses: '200': description: >- Modification confirmation. Returns resulting EmailContentSharingSalesUnitRelation content: application/json: schema: $ref: >- #/components/schemas/EmailModifyContentSharingSalesUnitRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qiup07k4d83ln /entities/EmailContentSharingSalesUnitRelations: get: tags: - Email summary: EmailContentSharingSalesUnitRelations.list operationId: Email_getAllRelations description: Returns all defined EmailContentSharingSalesUnitRelations parameters: - description: >- if enabled, deleted EmailContentSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailContentSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/EmailGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bvjve66wc7fbv post: tags: - Email summary: EmailContentSharingSalesUnitRelations.create operationId: Email_createRelation description: Creates new EmailContentSharingSalesUnitRelation parameters: - description: >- Specify validation level of EmailContentSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createEmailContentSharingSalesUnitRelationInput responses: '201': description: >- Creation confirmation. Returns created EmailContentSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/EmailCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kgjjg7wh0k0fj /entities/EmailContentSharingSalesUnitRelations/batch-delete: post: tags: - Email summary: EmailContentSharingSalesUnitRelations.batch_delete operationId: Email_removeByIds description: Removes EmailContentSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of EmailContentSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9281tw0j65zky /entities/EmailContentSharingSalesUnitRelations/batch-modify: post: tags: - Email summary: EmailContentSharingSalesUnitRelations.batch_create_or_update operationId: Email_modifyBatchEmailContentSharingSalesUnitRelations description: Create or update an batch of EmailContentSharingSalesUnitRelations parameters: - description: >- Specify validation level of EmailContentSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/EmailModifyBatchEmailContentSharingSalesUnitRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailContentSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/EmailModifyBatchEmailContentSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iiqr5mc5qfyh8 /entities/EmailEvents/{id}: get: tags: - Email summary: EmailEvents.get operationId: Email_getById description: Returns EmailEvent with given id parameters: - description: ID of EmailEvent to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailEvent data content: application/json: schema: $ref: '#/components/schemas/EmailGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bsytmmy7mfelg delete: tags: - Email summary: EmailEvents.delete operationId: Email_removeById description: Removes EmailEvent with given id parameters: - description: ID of EmailEvent to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailEvent on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1pkw52piy9io0 patch: tags: - Email summary: EmailEvents.update operationId: Email_modifyById description: Modifies EmailEvent or EmailEvents with given id(s) parameters: - description: ID of EmailEvent to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailEvent on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailEventInput' responses: '200': description: Modification confirmation. Returns resulting EmailEvent content: application/json: schema: $ref: '#/components/schemas/EmailModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g4yvyo3iffplw /entities/EmailEvents: get: tags: - Email summary: EmailEvents.list operationId: Email_getAllDefined description: Returns all defined EmailEvents parameters: - description: if enabled, deleted EmailEvents are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailEvents content: application/json: schema: $ref: '#/components/schemas/EmailGetAllDefined200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jcndfmlap3e5l post: tags: - Email summary: EmailEvents.create operationId: Email_createNewEmailEvent description: Creates new EmailEvent parameters: - description: >- Specify validation level of EmailEvent on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailEvent required: true content: application / json: schema: $ref: '#/components/schemas/createEmailEventInput' responses: '201': description: Creation confirmation. Returns created EmailEvent content: application/json: schema: $ref: '#/components/schemas/EmailCreateNewEmailEventResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k6qh6wuh78612 /entities/EmailEvents/batch-delete: post: tags: - Email summary: EmailEvents.batch_delete operationId: Email_removeBatchEvents description: Removes EmailEvents with given list of ids parameters: - description: >- Specify validation level of EmailEvents on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailEvents. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchEventsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatchEventsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: isjeh78ps9sq9 /entities/EmailEvents/batch-modify: post: tags: - Email summary: EmailEvents.batch_create_or_update operationId: Email_modifyBatchEvents description: Create or update an batch of EmailEvents parameters: - description: >- Specify validation level of EmailEvents on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailEvents. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailEvent required: true content: application / json: schema: $ref: '#/components/schemas/EmailModifyBatchEventsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailEvents content: application/json: schema: $ref: '#/components/schemas/EmailModifyBatchEventsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vhxjn5ed4xzg2 /entities/EmailSequences/{id}: get: tags: - Email Sequence summary: EmailSequences.get operationId: EmailSequence_getById description: Returns EmailSequence with given id parameters: - description: ID of EmailSequence to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailSequence data content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eee1mfshfwhgp delete: tags: - Email Sequence summary: EmailSequences.delete operationId: EmailSequence_removeById description: Removes EmailSequence with given id parameters: - description: ID of EmailSequence to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequence 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r9gkyjg112iri patch: tags: - Email Sequence summary: EmailSequences.update operationId: EmailSequence_modifyById description: Modifies EmailSequence or EmailSequences with given id(s) parameters: - description: ID of EmailSequence to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequence 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailSequenceInput' responses: '200': description: Modification confirmation. Returns resulting EmailSequence content: application/json: schema: $ref: '#/components/schemas/EmailSequenceModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6swdenginfdd8 /entities/EmailSequences: get: tags: - Email Sequence summary: EmailSequences.list operationId: EmailSequence_getAll description: Returns all defined EmailSequences parameters: - description: if enabled, deleted EmailSequences are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailSequences content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ypf1gtvegd86o post: tags: - Email Sequence summary: EmailSequences.create operationId: EmailSequence_createNewSequence description: Creates new EmailSequence parameters: - description: >- Specify validation level of EmailSequence 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequence required: true content: application / json: schema: $ref: '#/components/schemas/createEmailSequenceInput' responses: '201': description: Creation confirmation. Returns created EmailSequence content: application/json: schema: $ref: '#/components/schemas/EmailSequenceCreateNewSequenceResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bg4gfsvmnzpoy /entities/EmailSequences/batch-delete: post: tags: - Email Sequence summary: EmailSequences.batch_delete operationId: EmailSequence_removeBatch description: Removes EmailSequences with given list of ids parameters: - description: >- Specify validation level of EmailSequences 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4o08zg2xu4l5l /entities/EmailSequences/batch-modify: post: tags: - Email Sequence summary: EmailSequences.batch_create_or_update operationId: EmailSequence_batchModify description: Create or update an batch of EmailSequences parameters: - description: >- Specify validation level of EmailSequences 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequence required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailSequences content: application/json: schema: $ref: '#/components/schemas/EmailSequenceBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oeerdveari9od /entities/EmailSequenceActivityLogs/{id}: get: tags: - Email Sequence summary: EmailSequenceActivityLogs.get operationId: EmailSequence_getById description: Returns EmailSequenceActivityLog with given id parameters: - description: ID of EmailSequenceActivityLog to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailSequenceActivityLog data content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n7rvz2sghwoor delete: tags: - Email Sequence summary: EmailSequenceActivityLogs.delete operationId: EmailSequence_removeById description: Removes EmailSequenceActivityLog with given id parameters: - description: ID of EmailSequenceActivityLog to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceActivityLog 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mdbwv47yksyst patch: tags: - Email Sequence summary: EmailSequenceActivityLogs.update operationId: EmailSequence_modifyLogById description: >- Modifies EmailSequenceActivityLog or EmailSequenceActivityLogs with given id(s) parameters: - description: ID of EmailSequenceActivityLog to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceActivityLog 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailSequenceActivityLogInput' responses: '200': description: >- Modification confirmation. Returns resulting EmailSequenceActivityLog content: application/json: schema: $ref: '#/components/schemas/EmailSequenceModifyLogByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4ba6jlfti8fgv /entities/EmailSequenceActivityLogs: get: tags: - Email Sequence summary: EmailSequenceActivityLogs.list operationId: EmailSequence_getAllLogs description: Returns all defined EmailSequenceActivityLogs parameters: - description: if enabled, deleted EmailSequenceActivityLogs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailSequenceActivityLogs content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetAllLogsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s2ln1egvxkkxo post: tags: - Email Sequence summary: EmailSequenceActivityLogs.create operationId: EmailSequence_createActivityLog description: Creates new EmailSequenceActivityLog parameters: - description: >- Specify validation level of EmailSequenceActivityLog 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceActivityLog required: true content: application / json: schema: $ref: '#/components/schemas/createEmailSequenceActivityLogInput' responses: '201': description: Creation confirmation. Returns created EmailSequenceActivityLog content: application/json: schema: $ref: '#/components/schemas/EmailSequenceCreateActivityLogResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jnonkcdzmsj6z /entities/EmailSequenceActivityLogs/batch-delete: post: tags: - Email Sequence summary: EmailSequenceActivityLogs.batch_delete operationId: EmailSequence_removeBatch description: Removes EmailSequenceActivityLogs with given list of ids parameters: - description: >- Specify validation level of EmailSequenceActivityLogs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceActivityLogs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: col6zohvfc0h9 /entities/EmailSequenceActivityLogs/batch-modify: post: tags: - Email Sequence summary: EmailSequenceActivityLogs.batch_create_or_update operationId: EmailSequence_modifyBatchLogs description: Create or update an batch of EmailSequenceActivityLogs parameters: - description: >- Specify validation level of EmailSequenceActivityLogs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceActivityLogs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceActivityLog required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceModifyBatchLogsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailSequenceActivityLogs content: application/json: schema: $ref: '#/components/schemas/EmailSequenceModifyBatchLogsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: thfv1lxp5bk5p /entities/EmailSequenceActivityLogLines/{id}: get: tags: - Email Sequence summary: EmailSequenceActivityLogLines.get operationId: EmailSequence_getById description: Returns EmailSequenceActivityLogLine with given id parameters: - description: ID of EmailSequenceActivityLogLine to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailSequenceActivityLogLine data content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 34zw9vrfzfoyn delete: tags: - Email Sequence summary: EmailSequenceActivityLogLines.delete operationId: EmailSequence_removeById description: Removes EmailSequenceActivityLogLine with given id parameters: - description: ID of EmailSequenceActivityLogLine to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: arj9y0hd6vj5j patch: tags: - Email Sequence summary: EmailSequenceActivityLogLines.update operationId: EmailSequence_modifyLogLine description: >- Modifies EmailSequenceActivityLogLine or EmailSequenceActivityLogLines with given id(s) parameters: - description: ID of EmailSequenceActivityLogLine to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailSequenceActivityLogLineInput' responses: '200': description: >- Modification confirmation. Returns resulting EmailSequenceActivityLogLine content: application/json: schema: $ref: '#/components/schemas/EmailSequenceModifyLogLineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: t4brs2j8bbtmn /entities/EmailSequenceActivityLogLines: get: tags: - Email Sequence summary: EmailSequenceActivityLogLines.list operationId: EmailSequence_getAll description: Returns all defined EmailSequenceActivityLogLines parameters: - description: >- if enabled, deleted EmailSequenceActivityLogLines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailSequenceActivityLogLines content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetAll200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9kadl1x8hzr2o post: tags: - Email Sequence summary: EmailSequenceActivityLogLines.create operationId: EmailSequence_addNewLogLine description: Creates new EmailSequenceActivityLogLine parameters: - description: >- Specify validation level of EmailSequenceActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/createEmailSequenceActivityLogLineInput' responses: '201': description: Creation confirmation. Returns created EmailSequenceActivityLogLine content: application/json: schema: $ref: '#/components/schemas/EmailSequenceAddNewLogLineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ndimj0aujgpmn /entities/EmailSequenceActivityLogLines/batch-delete: post: tags: - Email Sequence summary: EmailSequenceActivityLogLines.batch_delete operationId: EmailSequence_removeByIds description: Removes EmailSequenceActivityLogLines with given list of ids parameters: - description: >- Specify validation level of EmailSequenceActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: afwbrv0htjbua /entities/EmailSequenceActivityLogLines/batch-modify: post: tags: - Email Sequence summary: EmailSequenceActivityLogLines.batch_create_or_update operationId: EmailSequence_processBatchModify description: Create or update an batch of EmailSequenceActivityLogLines parameters: - description: >- Specify validation level of EmailSequenceActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceProcessBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailSequenceActivityLogLines content: application/json: schema: $ref: '#/components/schemas/EmailSequenceProcessBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tb4mfcmvf9jm4 /entities/EmailSequenceEnrolleds/{id}: get: tags: - Email Sequence summary: EmailSequenceEnrolleds.get operationId: EmailSequence_getById description: Returns EmailSequenceEnrolled with given id parameters: - description: ID of EmailSequenceEnrolled to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailSequenceEnrolled data content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x33l1o6jvguaz delete: tags: - Email Sequence summary: EmailSequenceEnrolleds.delete operationId: EmailSequence_removeById description: Removes EmailSequenceEnrolled with given id parameters: - description: ID of EmailSequenceEnrolled to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceEnrolled 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gitb16xr21xhj patch: tags: - Email Sequence summary: EmailSequenceEnrolleds.update operationId: EmailSequence_modifyEnrolled description: >- Modifies EmailSequenceEnrolled or EmailSequenceEnrolleds with given id(s) parameters: - description: ID of EmailSequenceEnrolled to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailSequenceEnrolled 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailSequenceEnrolledInput' responses: '200': description: Modification confirmation. Returns resulting EmailSequenceEnrolled content: application/json: schema: $ref: '#/components/schemas/EmailSequenceModifyEnrolledResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: voq839fdkwzu3 /entities/EmailSequenceEnrolleds: get: tags: - Email Sequence summary: EmailSequenceEnrolleds.list operationId: EmailSequence_getAll description: Returns all defined EmailSequenceEnrolleds parameters: - description: if enabled, deleted EmailSequenceEnrolleds are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailSequenceEnrolleds content: application/json: schema: $ref: '#/components/schemas/EmailSequenceGetAll200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 997lobe93g2x4 post: tags: - Email Sequence summary: EmailSequenceEnrolleds.create operationId: EmailSequence_enrollNew description: Creates new EmailSequenceEnrolled parameters: - description: >- Specify validation level of EmailSequenceEnrolled 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceEnrolled required: true content: application / json: schema: $ref: '#/components/schemas/createEmailSequenceEnrolledInput' responses: '201': description: Creation confirmation. Returns created EmailSequenceEnrolled content: application/json: schema: $ref: '#/components/schemas/EmailSequenceEnrollNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4qen3fvffbi46 /entities/EmailSequenceEnrolleds/batch-delete: post: tags: - Email Sequence summary: EmailSequenceEnrolleds.batch_delete operationId: EmailSequence_removeBatch description: Removes EmailSequenceEnrolleds with given list of ids parameters: - description: >- Specify validation level of EmailSequenceEnrolleds 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceEnrolleds. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailSequenceRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7xfujlnts6ypg /entities/EmailSequenceEnrolleds/batch-modify: post: tags: - Email Sequence summary: EmailSequenceEnrolleds.batch_create_or_update operationId: EmailSequence_batchCreateOrUpdate description: Create or update an batch of EmailSequenceEnrolleds parameters: - description: >- Specify validation level of EmailSequenceEnrolleds 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailSequenceEnrolleds. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailSequenceEnrolled required: true content: application / json: schema: $ref: '#/components/schemas/EmailSequenceBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailSequenceEnrolleds content: application/json: schema: $ref: '#/components/schemas/EmailSequenceBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hm8eppwy8cz2p /entities/EmailTemplates/{id}: get: tags: - Email summary: EmailTemplates.get operationId: Email_getById description: Returns EmailTemplate with given id parameters: - description: ID of EmailTemplate to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailTemplate data content: application/json: schema: $ref: '#/components/schemas/EmailGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i5u9wvjqpi2lq delete: tags: - Email summary: EmailTemplates.delete operationId: Email_removeById description: Removes EmailTemplate with given id parameters: - description: ID of EmailTemplate to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplate on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rxgn71eigyik4 patch: tags: - Email summary: EmailTemplates.update operationId: Email_modifyTemplate description: Modifies EmailTemplate or EmailTemplates with given id(s) parameters: - description: ID of EmailTemplate to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplate on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplate content: application/json: schema: $ref: '#/components/schemas/EmailModifyTemplateResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p8ajhes5c92bt /entities/EmailTemplates: get: tags: - Email summary: EmailTemplates.list operationId: Email_getAllTemplates description: Returns all defined EmailTemplates parameters: - description: if enabled, deleted EmailTemplates are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplates content: application/json: schema: $ref: '#/components/schemas/EmailGetAllTemplatesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z041g97ynkfy9 post: tags: - Email summary: EmailTemplates.create operationId: Email_createNewEmailTemplate description: Creates new EmailTemplate parameters: - description: >- Specify validation level of EmailTemplate on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplate required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateInput' responses: '201': description: Creation confirmation. Returns created EmailTemplate content: application/json: schema: $ref: '#/components/schemas/EmailCreateNewEmailTemplateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e1rbwih6g4yuk /entities/EmailTemplates/batch-delete: post: tags: - Email summary: EmailTemplates.batch_delete operationId: Email_removeBatchEmailTemplates description: Removes EmailTemplates with given list of ids parameters: - description: >- Specify validation level of EmailTemplates on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchEmailTemplatesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatchEmailTemplatesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qe2wid9bjln74 /entities/EmailTemplates/batch-modify: post: tags: - Email summary: EmailTemplates.batch_create_or_update operationId: Email_modifyBatchTemplates description: Create or update an batch of EmailTemplates parameters: - description: >- Specify validation level of EmailTemplates on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplate required: true content: application / json: schema: $ref: '#/components/schemas/EmailModifyBatchTemplatesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailTemplates content: application/json: schema: $ref: '#/components/schemas/EmailModifyBatchTemplatesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gzrj9whngn2td /entities/EmailTemplateFolders/{id}: get: tags: - Email summary: EmailTemplateFolders.get operationId: Email_getTemplateFolder description: Returns EmailTemplateFolder with given id parameters: - description: ID of EmailTemplateFolder to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailTemplateFolder data content: application/json: schema: $ref: '#/components/schemas/EmailGetTemplateFolderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a51p95c0ri3lx delete: tags: - Email summary: EmailTemplateFolders.delete operationId: Email_removeTemplateFolder description: Removes EmailTemplateFolder with given id parameters: - description: ID of EmailTemplateFolder to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateFolder on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveTemplateFolderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s680tb3w4tg43 patch: tags: - Email summary: EmailTemplateFolders.update operationId: Email_modifyByIds description: Modifies EmailTemplateFolder or EmailTemplateFolders with given id(s) parameters: - description: ID of EmailTemplateFolder to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateFolder on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateFolderInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplateFolder content: application/json: schema: $ref: '#/components/schemas/EmailModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: co8q4imec4r5f /entities/EmailTemplateFolders: get: tags: - Email summary: EmailTemplateFolders.list operationId: Email_getAllFolders description: Returns all defined EmailTemplateFolders parameters: - description: if enabled, deleted EmailTemplateFolders are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateFolders content: application/json: schema: $ref: '#/components/schemas/EmailGetAllFoldersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 07e7nddxd0eg8 post: tags: - Email summary: EmailTemplateFolders.create operationId: Email_createFolder description: Creates new EmailTemplateFolder parameters: - description: >- Specify validation level of EmailTemplateFolder on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateFolder required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateFolderInput' responses: '201': description: Creation confirmation. Returns created EmailTemplateFolder content: application/json: schema: $ref: '#/components/schemas/EmailCreateFolderResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ul1ft1b79yvg8 /entities/EmailTemplateFolders/batch-delete: post: tags: - Email summary: EmailTemplateFolders.batch_delete operationId: Email_removeBatchEmailTemplateFolders description: Removes EmailTemplateFolders with given list of ids parameters: - description: >- Specify validation level of EmailTemplateFolders on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchEmailTemplateFoldersRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/EmailRemoveBatchEmailTemplateFoldersResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0f8t0rti83wl0 /entities/EmailTemplateFolders/batch-modify: post: tags: - Email summary: EmailTemplateFolders.batch_create_or_update operationId: Email_modifyBatchTemplateFolders description: Create or update an batch of EmailTemplateFolders parameters: - description: >- Specify validation level of EmailTemplateFolders on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateFolder required: true content: application / json: schema: $ref: '#/components/schemas/EmailModifyBatchTemplateFoldersRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailTemplateFolders content: application/json: schema: $ref: '#/components/schemas/EmailModifyBatchTemplateFoldersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sa0d5l1u1qnah /entities/EmailTemplateSharingClientRelations/{id}: get: tags: - Email summary: EmailTemplateSharingClientRelations.get operationId: Email_getById description: Returns EmailTemplateSharingClientRelation with given id parameters: - description: ID of EmailTemplateSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailTemplateSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/EmailGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hd7elp3ejgtxf delete: tags: - Email summary: EmailTemplateSharingClientRelations.delete operationId: Email_removeById description: Removes EmailTemplateSharingClientRelation with given id parameters: - description: ID of EmailTemplateSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dc3rb1l72kpbw patch: tags: - Email summary: EmailTemplateSharingClientRelations.update operationId: Email_updateRelation description: >- Modifies EmailTemplateSharingClientRelation or EmailTemplateSharingClientRelations with given id(s) parameters: - description: ID of EmailTemplateSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateEmailTemplateSharingClientRelationInput responses: '200': description: >- Modification confirmation. Returns resulting EmailTemplateSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/EmailUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xs9ezd0hfa08n /entities/EmailTemplateSharingClientRelations: get: tags: - Email summary: EmailTemplateSharingClientRelations.list operationId: Email_listEmailTemplateSharingClientRelations description: Returns all defined EmailTemplateSharingClientRelations parameters: - description: >- if enabled, deleted EmailTemplateSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/EmailListEmailTemplateSharingClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3ytxfsvalih7h post: tags: - Email summary: EmailTemplateSharingClientRelations.create operationId: Email_createNewEmailTemplateSharingClientRelation description: Creates new EmailTemplateSharingClientRelation parameters: - description: >- Specify validation level of EmailTemplateSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingClientRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createEmailTemplateSharingClientRelationInput responses: '201': description: >- Creation confirmation. Returns created EmailTemplateSharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/EmailCreateNewEmailTemplateSharingClientRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ydpe22xa8kqt6 /entities/EmailTemplateSharingClientRelations/batch-delete: post: tags: - Email summary: EmailTemplateSharingClientRelations.batch_delete operationId: Email_removeBatchByIds description: Removes EmailTemplateSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of EmailTemplateSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: os19trrvldncs /entities/EmailTemplateSharingClientRelations/batch-modify: post: tags: - Email summary: EmailTemplateSharingClientRelations.batch_create_or_update operationId: Email_templateBatchModify description: Create or update an batch of EmailTemplateSharingClientRelations parameters: - description: >- Specify validation level of EmailTemplateSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/EmailTemplateBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailTemplateSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/EmailTemplateBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rznevgjghoeoz /entities/EmailTemplateSharingSalesUnitRelations/{id}: get: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.get operationId: Email_getById description: Returns EmailTemplateSharingSalesUnitRelation with given id parameters: - description: ID of EmailTemplateSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EmailTemplateSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/EmailGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: raon8k6i8xbel delete: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.delete operationId: Email_removeById description: Removes EmailTemplateSharingSalesUnitRelation with given id parameters: - description: ID of EmailTemplateSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6ejzzc7g3h4t8 patch: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.update operationId: Email_modifySalesUnitRelations description: >- Modifies EmailTemplateSharingSalesUnitRelation or EmailTemplateSharingSalesUnitRelations with given id(s) parameters: - description: ID of EmailTemplateSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EmailTemplateSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateEmailTemplateSharingSalesUnitRelationInput responses: '200': description: >- Modification confirmation. Returns resulting EmailTemplateSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/EmailModifySalesUnitRelationsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rox586r7rsrlx /entities/EmailTemplateSharingSalesUnitRelations: get: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.list operationId: Email_getAllDefinedSalesUnitRelations description: Returns all defined EmailTemplateSharingSalesUnitRelations parameters: - description: >- if enabled, deleted EmailTemplateSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/EmailGetAllDefinedSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dwchx0yd14yjz post: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.create operationId: Email_createRelation description: Creates new EmailTemplateSharingSalesUnitRelation parameters: - description: >- Specify validation level of EmailTemplateSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createEmailTemplateSharingSalesUnitRelationInput responses: '201': description: >- Creation confirmation. Returns created EmailTemplateSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/EmailCreateRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zwvlrerk93bfy /entities/EmailTemplateSharingSalesUnitRelations/batch-delete: post: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.batch_delete operationId: Email_removeBatch description: Removes EmailTemplateSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of EmailTemplateSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/EmailRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/EmailRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ypez9iigzmerx /entities/EmailTemplateSharingSalesUnitRelations/batch-modify: post: tags: - Email summary: EmailTemplateSharingSalesUnitRelations.batch_create_or_update operationId: Email_modifyBatchEmailTemplateSharingSalesUnitRelations description: Create or update an batch of EmailTemplateSharingSalesUnitRelations parameters: - description: >- Specify validation level of EmailTemplateSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/EmailModifyBatchEmailTemplateSharingSalesUnitRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated EmailTemplateSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/EmailModifyBatchEmailTemplateSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oc1nfrc4cjmex /entities/Entities/{id}: get: tags: - Custom Entity summary: Entities.get operationId: CustomEntity_getById description: Returns Entity with given id parameters: - description: ID of Entity to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Entity data content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o8pc7a6yrx1je /entities/Entities: get: tags: - Custom Entity summary: Entities.list operationId: CustomEntity_getAllEntities description: Returns all defined Entities parameters: - description: if enabled, deleted Entities are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Entities content: application/json: schema: $ref: '#/components/schemas/CustomEntityGetAllEntities200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3m7vmlsy9hwx3 /entities/EntityFitnesses/{id}: get: tags: - Opportunity summary: EntityFitnesses.get operationId: Opportunity_getFitness description: Returns EntityFitness with given id parameters: - description: ID of EntityFitness to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EntityFitness data content: application/json: schema: $ref: '#/components/schemas/OpportunityGetFitnessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: duodbxagjfku9 delete: tags: - Opportunity summary: EntityFitnesses.delete operationId: Opportunity_removeFitness description: Removes EntityFitness with given id parameters: - description: ID of EntityFitness to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityFitness 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OpportunityRemoveFitnessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w0jv9exa4330k patch: tags: - Opportunity summary: EntityFitnesses.update operationId: Opportunity_modifyFitness description: Modifies EntityFitness or EntityFitnesses with given id(s) parameters: - description: ID of EntityFitness to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityFitness 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEntityFitnessInput' responses: '200': description: Modification confirmation. Returns resulting EntityFitness content: application/json: schema: $ref: '#/components/schemas/OpportunityModifyFitnessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fgt56cy1n8vvd /entities/EntityFitnesses: get: tags: - Opportunity summary: EntityFitnesses.list operationId: Opportunity_getAllEntityFitnesses description: Returns all defined EntityFitnesses parameters: - description: if enabled, deleted EntityFitnesses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EntityFitnesses content: application/json: schema: $ref: '#/components/schemas/OpportunityGetAllEntityFitnessesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b1sxcptvduixb post: tags: - Opportunity summary: EntityFitnesses.create operationId: Opportunity_createFitness description: Creates new EntityFitness parameters: - description: >- Specify validation level of EntityFitness 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EntityFitness required: true content: application / json: schema: $ref: '#/components/schemas/createEntityFitnessInput' responses: '201': description: Creation confirmation. Returns created EntityFitness content: application/json: schema: $ref: '#/components/schemas/OpportunityCreateFitnessResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jhua688y1e1zj /entities/EntityFitnesses/batch-delete: post: tags: - Opportunity summary: EntityFitnesses.batch_delete operationId: Opportunity_removeBatch description: Removes EntityFitnesses with given list of ids parameters: - description: >- Specify validation level of EntityFitnesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityFitnesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OpportunityRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OpportunityRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gcpucqcvizvdl /entities/EntityFitnesses/batch-modify: post: tags: - Opportunity summary: EntityFitnesses.batch_create_or_update operationId: Opportunity_batchModifyEntityFitnesses description: Create or update an batch of EntityFitnesses parameters: - description: >- Specify validation level of EntityFitnesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityFitnesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EntityFitness required: true content: application / json: schema: $ref: >- #/components/schemas/OpportunityBatchModifyEntityFitnessesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated EntityFitnesses content: application/json: schema: $ref: >- #/components/schemas/OpportunityBatchModifyEntityFitnessesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cuq1a5dw0vayt /entities/EntityFitnessIndicators/{id}: get: tags: - Opportunity summary: EntityFitnessIndicators.get operationId: Opportunity_getFitnessIndicator description: Returns EntityFitnessIndicator with given id parameters: - description: ID of EntityFitnessIndicator to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EntityFitnessIndicator data content: application/json: schema: $ref: '#/components/schemas/OpportunityGetFitnessIndicatorResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p34rzw0jippbs delete: tags: - Opportunity summary: EntityFitnessIndicators.delete operationId: Opportunity_removeById description: Removes EntityFitnessIndicator with given id parameters: - description: ID of EntityFitnessIndicator to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityFitnessIndicator 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OpportunityRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5rl8n81ld5wja patch: tags: - Opportunity summary: EntityFitnessIndicators.update operationId: Opportunity_updateFitnessIndicatorsById description: >- Modifies EntityFitnessIndicator or EntityFitnessIndicators with given id(s) parameters: - description: ID of EntityFitnessIndicator to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityFitnessIndicator 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEntityFitnessIndicatorInput' responses: '200': description: Modification confirmation. Returns resulting EntityFitnessIndicator content: application/json: schema: $ref: >- #/components/schemas/OpportunityUpdateFitnessIndicatorsByIdResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: makc2rvb53nib /entities/EntityFitnessIndicators: get: tags: - Opportunity summary: EntityFitnessIndicators.list operationId: Opportunity_listEntityFitnessIndicators description: Returns all defined EntityFitnessIndicators parameters: - description: if enabled, deleted EntityFitnessIndicators are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EntityFitnessIndicators content: application/json: schema: $ref: >- #/components/schemas/OpportunityListEntityFitnessIndicatorsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zun8tu2frc98h post: tags: - Opportunity summary: EntityFitnessIndicators.create operationId: Opportunity_createNewEntityFitnessIndicator description: Creates new EntityFitnessIndicator parameters: - description: >- Specify validation level of EntityFitnessIndicator 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EntityFitnessIndicator required: true content: application / json: schema: $ref: '#/components/schemas/createEntityFitnessIndicatorInput' responses: '201': description: Creation confirmation. Returns created EntityFitnessIndicator content: application/json: schema: $ref: >- #/components/schemas/OpportunityCreateNewEntityFitnessIndicatorResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yiepll14lz0rw /entities/EntityFitnessIndicators/batch-delete: post: tags: - Opportunity summary: EntityFitnessIndicators.batch_delete operationId: Opportunity_batchDeleteEntityFitnessIndicators description: Removes EntityFitnessIndicators with given list of ids parameters: - description: >- Specify validation level of EntityFitnessIndicators 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityFitnessIndicators. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/OpportunityBatchDeleteEntityFitnessIndicatorsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/OpportunityBatchDeleteEntityFitnessIndicatorsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7crrjq1n7g2pw /entities/EntityFitnessIndicators/batch-modify: post: tags: - Opportunity summary: EntityFitnessIndicators.batch_create_or_update operationId: Opportunity_modifyEntityFitnessIndicatorsBatch description: Create or update an batch of EntityFitnessIndicators parameters: - description: >- Specify validation level of EntityFitnessIndicators 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityFitnessIndicators. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EntityFitnessIndicator required: true content: application / json: schema: $ref: >- #/components/schemas/OpportunityModifyEntityFitnessIndicatorsBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated EntityFitnessIndicators content: application/json: schema: $ref: >- #/components/schemas/OpportunityModifyEntityFitnessIndicatorsBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8un7eir791eyv /entities/EntityHealths/{id}: get: tags: - Account summary: EntityHealths.get operationId: Account_getEntityHealth description: Returns EntityHealth with given id parameters: - description: ID of EntityHealth to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EntityHealth data content: application/json: schema: $ref: '#/components/schemas/AccountGetEntityHealthResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5s5e84rtfqb0n delete: tags: - Account summary: EntityHealths.delete operationId: Account_removeById description: Removes EntityHealth with given id parameters: - description: ID of EntityHealth to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityHealth 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5dwtwzgl5h5pi patch: tags: - Account summary: EntityHealths.update operationId: Account_modifyHealth description: Modifies EntityHealth or EntityHealths with given id(s) parameters: - description: ID of EntityHealth to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityHealth 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEntityHealthInput' responses: '200': description: Modification confirmation. Returns resulting EntityHealth content: application/json: schema: $ref: '#/components/schemas/AccountModifyHealthResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2ym8921szc1yc /entities/EntityHealths: get: tags: - Account summary: EntityHealths.list operationId: Account_getAllEntityHealths description: Returns all defined EntityHealths parameters: - description: if enabled, deleted EntityHealths are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EntityHealths content: application/json: schema: $ref: '#/components/schemas/AccountGetAllEntityHealthsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 48ok4mzwo52kp post: tags: - Account summary: EntityHealths.create operationId: Account_createEntityHealth description: Creates new EntityHealth parameters: - description: >- Specify validation level of EntityHealth 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EntityHealth required: true content: application / json: schema: $ref: '#/components/schemas/createEntityHealthInput' responses: '201': description: Creation confirmation. Returns created EntityHealth content: application/json: schema: $ref: '#/components/schemas/AccountCreateEntityHealthResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p5m28aopawzpa /entities/EntityHealths/batch-delete: post: tags: - Account summary: EntityHealths.batch_delete operationId: Account_removeBatchEntityHealths description: Removes EntityHealths with given list of ids parameters: - description: >- Specify validation level of EntityHealths 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/AccountRemoveBatchEntityHealthsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveBatchEntityHealthsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6z9ezkyaq9f5x /entities/EntityHealths/batch-modify: post: tags: - Account summary: EntityHealths.batch_create_or_update operationId: Account_modifyEntityHealthsBatch description: Create or update an batch of EntityHealths parameters: - description: >- Specify validation level of EntityHealths 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EntityHealth required: true content: application / json: schema: $ref: '#/components/schemas/AccountModifyEntityHealthsBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated EntityHealths content: application/json: schema: $ref: '#/components/schemas/AccountModifyEntityHealthsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 73w1c8q1tepnf /entities/EntityScorings/{id}: get: tags: - Lead summary: EntityScorings.get operationId: Lead_getById description: Returns EntityScoring with given id parameters: - description: ID of EntityScoring to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: EntityScoring data content: application/json: schema: $ref: '#/components/schemas/LeadGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jjcot99mm4y9q delete: tags: - Lead summary: EntityScorings.delete operationId: Lead_removeById description: Removes EntityScoring with given id parameters: - description: ID of EntityScoring to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityScoring 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nfdup58s96074 patch: tags: - Lead summary: EntityScorings.update operationId: Lead_modifyScoring description: Modifies EntityScoring or EntityScorings with given id(s) parameters: - description: ID of EntityScoring to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of EntityScoring 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEntityScoringInput' responses: '200': description: Modification confirmation. Returns resulting EntityScoring content: application/json: schema: $ref: '#/components/schemas/LeadModifyScoringResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8mgt257um0qef /entities/EntityScorings: get: tags: - Lead summary: EntityScorings.list operationId: Lead_getAllEntityScorings description: Returns all defined EntityScorings parameters: - description: if enabled, deleted EntityScorings are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EntityScorings content: application/json: schema: $ref: '#/components/schemas/LeadGetAllEntityScoringsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ejvgw645cu3zx post: tags: - Lead summary: EntityScorings.create operationId: Lead_createEntityScoring description: Creates new EntityScoring parameters: - description: >- Specify validation level of EntityScoring 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new EntityScoring required: true content: application / json: schema: $ref: '#/components/schemas/createEntityScoringInput' responses: '201': description: Creation confirmation. Returns created EntityScoring content: application/json: schema: $ref: '#/components/schemas/LeadCreateEntityScoringResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aw9wdyxhwmhqe /entities/EntityScorings/batch-delete: post: tags: - Lead summary: EntityScorings.batch_delete operationId: Lead_removeBatchEntityScorings description: Removes EntityScorings with given list of ids parameters: - description: >- Specify validation level of EntityScorings 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityScorings. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadRemoveBatchEntityScoringsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadRemoveBatchEntityScoringsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qd2r7wf9it3f8 /entities/EntityScorings/batch-modify: post: tags: - Lead summary: EntityScorings.batch_create_or_update operationId: Lead_createOrUpdateBatchEntityScorings description: Create or update an batch of EntityScorings parameters: - description: >- Specify validation level of EntityScorings 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for EntityScorings. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new EntityScoring required: true content: application / json: schema: $ref: >- #/components/schemas/LeadCreateOrUpdateBatchEntityScoringsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated EntityScorings content: application/json: schema: $ref: >- #/components/schemas/LeadCreateOrUpdateBatchEntityScoringsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ql3o972vnbyi8 /entities/Fields/{id}: get: tags: - Field summary: Fields.get operationId: Field_getById description: Returns Field with given id parameters: - description: ID of Field to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Field data content: application/json: schema: $ref: '#/components/schemas/FieldGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x1ts1wfuaec76 delete: tags: - Field summary: Fields.delete operationId: Field_removeById description: Removes Field with given id parameters: - description: ID of Field to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Field 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/FieldRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9k6207goj5h54 patch: tags: - Field summary: Fields.update operationId: Field_modifyById description: Modifies Field or Fields with given id(s) parameters: - description: ID of Field to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Field 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateFieldInput' responses: '200': description: Modification confirmation. Returns resulting Field content: application/json: schema: $ref: '#/components/schemas/FieldModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: disp12tmhdla4 /entities/Fields: get: tags: - Field summary: Fields.list operationId: Field_getAllDefined description: Returns all defined Fields parameters: - description: if enabled, deleted Fields are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Fields content: application/json: schema: $ref: '#/components/schemas/FieldGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r3f3k0j0xmav0 post: tags: - Field summary: Fields.create operationId: Field_addNewField description: Creates new Field parameters: - description: >- Specify validation level of Field 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Field required: true content: application / json: schema: $ref: '#/components/schemas/createFieldInput' responses: '201': description: Creation confirmation. Returns created Field content: application/json: schema: $ref: '#/components/schemas/FieldAddNewFieldResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q0mbvqu06glbk /entities/FieldPermissions/{id}: get: tags: - Field summary: FieldPermissions.get operationId: Field_getById description: Returns FieldPermission with given id parameters: - description: ID of FieldPermission to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: FieldPermission data content: application/json: schema: $ref: '#/components/schemas/FieldGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8the9k289r8id delete: tags: - Field summary: FieldPermissions.delete operationId: Field_removeById description: Removes FieldPermission with given id parameters: - description: ID of FieldPermission to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FieldPermission 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/FieldRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p728l4vq5ets2 patch: tags: - Field summary: FieldPermissions.update operationId: Field_modifyById description: Modifies FieldPermission or FieldPermissions with given id(s) parameters: - description: ID of FieldPermission to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FieldPermission 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateFieldPermissionInput' responses: '200': description: Modification confirmation. Returns resulting FieldPermission content: application/json: schema: $ref: '#/components/schemas/FieldModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f93cpmlv3k46g /entities/FieldPermissions: get: tags: - Field summary: FieldPermissions.list operationId: Field_getAllPermissions description: Returns all defined FieldPermissions parameters: - description: if enabled, deleted FieldPermissions are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of FieldPermissions content: application/json: schema: $ref: '#/components/schemas/FieldGetAllPermissionsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 93lgvf4tmxpjd post: tags: - Field summary: FieldPermissions.create operationId: Field_createFieldPermission description: Creates new FieldPermission parameters: - description: >- Specify validation level of FieldPermission 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new FieldPermission required: true content: application / json: schema: $ref: '#/components/schemas/createFieldPermissionInput' responses: '201': description: Creation confirmation. Returns created FieldPermission content: application/json: schema: $ref: '#/components/schemas/FieldCreateFieldPermissionResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l8nom7bx8eiy0 /entities/FieldPermissions/batch-delete: post: tags: - Field summary: FieldPermissions.batch_delete operationId: Field_removeBatch description: Removes FieldPermissions with given list of ids parameters: - description: >- Specify validation level of FieldPermissions 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FieldPermissions. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/FieldRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/FieldRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 01khkmozacvlw /entities/FieldPermissions/batch-modify: post: tags: - Field summary: FieldPermissions.batch_create_or_update operationId: Field_modifyBatchPermissions description: Create or update an batch of FieldPermissions parameters: - description: >- Specify validation level of FieldPermissions 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FieldPermissions. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new FieldPermission required: true content: application / json: schema: $ref: '#/components/schemas/FieldModifyBatchPermissionsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated FieldPermissions content: application/json: schema: $ref: '#/components/schemas/FieldModifyBatchPermissionsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mogfg3moquifw /entities/FieldSequences/{id}: get: tags: - Field summary: FieldSequences.get operationId: Field_getById description: Returns FieldSequence with given id parameters: - description: ID of FieldSequence to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: FieldSequence data content: application/json: schema: $ref: '#/components/schemas/FieldGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i8707w9pzuum3 /entities/FieldSequences: get: tags: - Field summary: FieldSequences.list operationId: Field_getAllFieldSequences description: Returns all defined FieldSequences parameters: - description: if enabled, deleted FieldSequences are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of FieldSequences content: application/json: schema: $ref: '#/components/schemas/FieldGetAllFieldSequencesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wpvk3lpxufs18 /entities/Forecasts/{id}: get: tags: - Forecast summary: Forecasts.get operationId: Forecast_getById description: Returns Forecast with given id parameters: - description: ID of Forecast to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Forecast data content: application/json: schema: $ref: '#/components/schemas/ForecastGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nlhh0zd4w69a9 delete: tags: - Forecast summary: Forecasts.delete operationId: Forecast_removeById description: Removes Forecast with given id parameters: - description: ID of Forecast to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Forecast 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ForecastRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ra6svii1bgs6b patch: tags: - Forecast summary: Forecasts.update operationId: Forecast_modifyById description: Modifies Forecast or Forecasts with given id(s) parameters: - description: ID of Forecast to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Forecast 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateForecastInput' responses: '200': description: Modification confirmation. Returns resulting Forecast content: application/json: schema: $ref: '#/components/schemas/ForecastModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jhj1zo87rtij5 /entities/Forecasts: get: tags: - Forecast summary: Forecasts.list operationId: Forecast_getAllForecasts description: Returns all defined Forecasts parameters: - description: if enabled, deleted Forecasts are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Forecasts content: application/json: schema: $ref: '#/components/schemas/ForecastGetAllForecastsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eh86j61ii7rdb post: tags: - Forecast summary: Forecasts.create operationId: Forecast_generateNewForecast description: Creates new Forecast parameters: - description: >- Specify validation level of Forecast 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Forecast required: true content: application / json: schema: $ref: '#/components/schemas/createForecastInput' responses: '201': description: Creation confirmation. Returns created Forecast content: application/json: schema: $ref: '#/components/schemas/ForecastGenerateNewForecastResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4yrimypb9vjkf /entities/Forecasts/batch-delete: post: tags: - Forecast summary: Forecasts.batch_delete operationId: Forecast_removeByIds description: Removes Forecasts with given list of ids parameters: - description: >- Specify validation level of Forecasts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Forecasts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ForecastRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ForecastRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yi7l6ppxymlij /entities/Forecasts/batch-modify: post: tags: - Forecast summary: Forecasts.batch_create_or_update operationId: Forecast_modifyBatchForecast description: Create or update an batch of Forecasts parameters: - description: >- Specify validation level of Forecasts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Forecasts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Forecast required: true content: application / json: schema: $ref: '#/components/schemas/ForecastModifyBatchForecastRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Forecasts content: application/json: schema: $ref: '#/components/schemas/ForecastModifyBatchForecastResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kv004sh3id6n3 /entities/FormViews/{id}: get: tags: - Form summary: FormViews.get operationId: Form_getById description: Returns FormView with given id parameters: - description: ID of FormView to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: FormView data content: application/json: schema: $ref: '#/components/schemas/FormGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mxrx5283n8r81 delete: tags: - Form summary: FormViews.delete operationId: Form_removeById description: Removes FormView with given id parameters: - description: ID of FormView to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormView 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a7zao5o4adjfs patch: tags: - Form summary: FormViews.update operationId: Form_modifyView description: Modifies FormView or FormViews with given id(s) parameters: - description: ID of FormView to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormView 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateFormViewInput' responses: '200': description: Modification confirmation. Returns resulting FormView content: application/json: schema: $ref: '#/components/schemas/FormModifyViewResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6o85uqehehcp6 /entities/FormViews: get: tags: - Form summary: FormViews.list operationId: Form_getAll description: Returns all defined FormViews parameters: - description: if enabled, deleted FormViews are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of FormViews content: application/json: schema: $ref: '#/components/schemas/FormGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8zkfsk2id7a9w post: tags: - Form summary: FormViews.create operationId: Form_createView description: Creates new FormView parameters: - description: >- Specify validation level of FormView 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new FormView required: true content: application / json: schema: $ref: '#/components/schemas/createFormViewInput' responses: '201': description: Creation confirmation. Returns created FormView content: application/json: schema: $ref: '#/components/schemas/FormCreateViewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d612zsqqs89ze /entities/FormViews/batch-delete: post: tags: - Form summary: FormViews.batch_delete operationId: Form_removeBatch description: Removes FormViews with given list of ids parameters: - description: >- Specify validation level of FormViews 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViews. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/FormRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ilmmbyzztu7om /entities/FormViews/batch-modify: post: tags: - Form summary: FormViews.batch_create_or_update operationId: Form_modifyBatchFormViews description: Create or update an batch of FormViews parameters: - description: >- Specify validation level of FormViews 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViews. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new FormView required: true content: application / json: schema: $ref: '#/components/schemas/FormModifyBatchFormViewsRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated FormViews content: application/json: schema: $ref: '#/components/schemas/FormModifyBatchFormViewsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fi5zbifmmogod /entities/FormViewSharingClientRelations/{id}: get: tags: - Form summary: FormViewSharingClientRelations.get operationId: Form_getById description: Returns FormViewSharingClientRelation with given id parameters: - description: ID of FormViewSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: FormViewSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/FormGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qurrhg4e42fi2 delete: tags: - Form summary: FormViewSharingClientRelations.delete operationId: Form_removeById description: Removes FormViewSharingClientRelation with given id parameters: - description: ID of FormViewSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormViewSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 76j4pw2qb8a1y patch: tags: - Form summary: FormViewSharingClientRelations.update operationId: Form_updateFormViewSharingClientRelation description: >- Modifies FormViewSharingClientRelation or FormViewSharingClientRelations with given id(s) parameters: - description: ID of FormViewSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormViewSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateFormViewSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting FormViewSharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/FormUpdateFormViewSharingClientRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nm629aj8f6i63 /entities/FormViewSharingClientRelations: get: tags: - Form summary: FormViewSharingClientRelations.list operationId: Form_getAllFormViewSharingClientRelations description: Returns all defined FormViewSharingClientRelations parameters: - description: >- if enabled, deleted FormViewSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of FormViewSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/FormGetAllFormViewSharingClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rrc4zoe3lkdbr post: tags: - Form summary: FormViewSharingClientRelations.create operationId: Form_createClientRelation description: Creates new FormViewSharingClientRelation parameters: - description: >- Specify validation level of FormViewSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new FormViewSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createFormViewSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created FormViewSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/FormCreateClientRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9hzklsnb15k47 /entities/FormViewSharingClientRelations/batch-delete: post: tags: - Form summary: FormViewSharingClientRelations.batch_delete operationId: Form_removeBatch description: Removes FormViewSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of FormViewSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViewSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/FormRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zziqshav3xb60 /entities/FormViewSharingClientRelations/batch-modify: post: tags: - Form summary: FormViewSharingClientRelations.batch_create_or_update operationId: Form_batchCreateOrUpdate description: Create or update an batch of FormViewSharingClientRelations parameters: - description: >- Specify validation level of FormViewSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViewSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new FormViewSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/FormBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated FormViewSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/FormBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f751kd7dy1rp0 /entities/FormViewSharingSalesUnitRelations/{id}: get: tags: - Form summary: FormViewSharingSalesUnitRelations.get operationId: Form_getById description: Returns FormViewSharingSalesUnitRelation with given id parameters: - description: ID of FormViewSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: FormViewSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/FormGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xcf2e9am3v9tu delete: tags: - Form summary: FormViewSharingSalesUnitRelations.delete operationId: Form_removeById description: Removes FormViewSharingSalesUnitRelation with given id parameters: - description: ID of FormViewSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormViewSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k93ai972b7vvy patch: tags: - Form summary: FormViewSharingSalesUnitRelations.update operationId: Form_modifySalesUnitRelation description: >- Modifies FormViewSharingSalesUnitRelation or FormViewSharingSalesUnitRelations with given id(s) parameters: - description: ID of FormViewSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of FormViewSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateFormViewSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting FormViewSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/FormModifySalesUnitRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: go1y1a0bq2vr6 /entities/FormViewSharingSalesUnitRelations: get: tags: - Form summary: FormViewSharingSalesUnitRelations.list operationId: Form_getAllSharingSalesUnitRelations description: Returns all defined FormViewSharingSalesUnitRelations parameters: - description: >- if enabled, deleted FormViewSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of FormViewSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/FormGetAllSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 07f1lwfzbr0h1 post: tags: - Form summary: FormViewSharingSalesUnitRelations.create operationId: Form_createNewRelation description: Creates new FormViewSharingSalesUnitRelation parameters: - description: >- Specify validation level of FormViewSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new FormViewSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createFormViewSharingSalesUnitRelationInput' responses: '201': description: >- Creation confirmation. Returns created FormViewSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/FormCreateNewRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vqbxu1af0h7s5 /entities/FormViewSharingSalesUnitRelations/batch-delete: post: tags: - Form summary: FormViewSharingSalesUnitRelations.batch_delete operationId: Form_removeByIds description: Removes FormViewSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of FormViewSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViewSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/FormRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/FormRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 66f8bzic7pkl1 /entities/FormViewSharingSalesUnitRelations/batch-modify: post: tags: - Form summary: FormViewSharingSalesUnitRelations.batch_create_or_update operationId: Form_batchCreateOrUpdate description: Create or update an batch of FormViewSharingSalesUnitRelations parameters: - description: >- Specify validation level of FormViewSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for FormViewSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new FormViewSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/FormBatchCreateOrUpdateRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated FormViewSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/FormBatchCreateOrUpdate200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: piahf4kiarcbz /entities/GhostContacts/{id}: get: tags: - Contact summary: GhostContacts.get operationId: Contact_getById description: Returns GhostContact with given id parameters: - description: ID of GhostContact to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: GhostContact data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response11' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vnhhy5mwlpsce delete: tags: - Contact summary: GhostContacts.delete operationId: Contact_removeById description: Removes GhostContact with given id parameters: - description: ID of GhostContact to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContact 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8qljondkkl5im patch: tags: - Contact summary: GhostContacts.update operationId: Contact_modifyById description: Modifies GhostContact or GhostContacts with given id(s) parameters: - description: ID of GhostContact to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContact 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostContactInput' responses: '200': description: Modification confirmation. Returns resulting GhostContact content: application/json: schema: $ref: '#/components/schemas/ContactModifyById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: be40pyq1iohn8 /entities/GhostContacts: get: tags: - Contact summary: GhostContacts.list operationId: Contact_getAllDefined description: Returns all defined GhostContacts parameters: - description: if enabled, deleted GhostContacts are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of GhostContacts content: application/json: schema: $ref: '#/components/schemas/ContactGetAllDefined200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gio3ajl4eixwt post: tags: - Contact summary: GhostContacts.create operationId: Contact_createNew description: Creates new GhostContact parameters: - description: >- Specify validation level of GhostContact 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new GhostContact required: true content: application / json: schema: $ref: '#/components/schemas/createGhostContactInput' responses: '201': description: Creation confirmation. Returns created GhostContact content: application/json: schema: $ref: '#/components/schemas/ContactCreateNew201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: msq2b6m6znhmh /entities/GhostContacts/batch-delete: post: tags: - Contact summary: GhostContacts.batch_delete operationId: Contact_removeBatch description: Removes GhostContacts with given list of ids parameters: - description: >- Specify validation level of GhostContacts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest4' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatch200Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dke8142ymu3ei /entities/GhostContacts/batch-modify: post: tags: - Contact summary: GhostContacts.batch_create_or_update operationId: Contact_modifyBatchGhost description: Create or update an batch of GhostContacts parameters: - description: >- Specify validation level of GhostContacts 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new GhostContact required: true content: application / json: schema: $ref: '#/components/schemas/ContactModifyBatchGhostRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated GhostContacts content: application/json: schema: $ref: '#/components/schemas/ContactModifyBatchGhostResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qqcx55evda3t0 /entities/GhostContactAccountAccountRoleRelations/{id}: get: tags: - Contact summary: GhostContactAccountAccountRoleRelations.get operationId: Contact_getById description: Returns GhostContactAccountAccountRoleRelation with given id parameters: - description: ID of GhostContactAccountAccountRoleRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: GhostContactAccountAccountRoleRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response12' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3mus0ln7zggev delete: tags: - Contact summary: GhostContactAccountAccountRoleRelations.delete operationId: Contact_removeById description: Removes GhostContactAccountAccountRoleRelation with given id parameters: - description: ID of GhostContactAccountAccountRoleRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response11' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 87upv14w3i5gg patch: tags: - Contact summary: GhostContactAccountAccountRoleRelations.update operationId: Contact_modifyRelation description: >- Modifies GhostContactAccountAccountRoleRelation or GhostContactAccountAccountRoleRelations with given id(s) parameters: - description: ID of GhostContactAccountAccountRoleRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateGhostContactAccountAccountRoleRelationInput responses: '200': description: >- Modification confirmation. Returns resulting GhostContactAccountAccountRoleRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifyRelation200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wncwy63u44d6e /entities/GhostContactAccountAccountRoleRelations: get: tags: - Contact summary: GhostContactAccountAccountRoleRelations.list operationId: Contact_listGhostAccountRoleRelations description: Returns all defined GhostContactAccountAccountRoleRelations parameters: - description: >- if enabled, deleted GhostContactAccountAccountRoleRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of GhostContactAccountAccountRoleRelations content: application/json: schema: $ref: >- #/components/schemas/ContactListGhostAccountRoleRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bjr2odudck0n3 post: tags: - Contact summary: GhostContactAccountAccountRoleRelations.create operationId: Contact_createGhostAccountRoleRelation description: Creates new GhostContactAccountAccountRoleRelation parameters: - description: >- Specify validation level of GhostContactAccountAccountRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createGhostContactAccountAccountRoleRelationInput responses: '201': description: >- Creation confirmation. Returns created GhostContactAccountAccountRoleRelation content: application/json: schema: $ref: >- #/components/schemas/ContactCreateGhostAccountRoleRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tl3eth3sxffwu /entities/GhostContactAccountAccountRoleRelations/batch-delete: post: tags: - Contact summary: GhostContactAccountAccountRoleRelations.batch_delete operationId: Contact_removeBatch description: Removes GhostContactAccountAccountRoleRelations with given list of ids parameters: - description: >- Specify validation level of GhostContactAccountAccountRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveBatchRequest5' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveBatch200Response4' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hp6q3klmqvcml /entities/GhostContactAccountAccountRoleRelations/batch-modify: post: tags: - Contact summary: GhostContactAccountAccountRoleRelations.batch_create_or_update operationId: Contact_createOrUpdateBatch description: Create or update an batch of GhostContactAccountAccountRoleRelations parameters: - description: >- Specify validation level of GhostContactAccountAccountRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactCreateOrUpdateBatchRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated GhostContactAccountAccountRoleRelations content: application/json: schema: $ref: '#/components/schemas/ContactCreateOrUpdateBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: znlcj7kmtqdmn /entities/GhostContactAccountRelations/{id}: get: tags: - Contact summary: GhostContactAccountRelations.get operationId: Contact_getRelationById description: Returns GhostContactAccountRelation with given id parameters: - description: ID of GhostContactAccountRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: GhostContactAccountRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetRelationByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ks6rsn61vdnv1 delete: tags: - Contact summary: GhostContactAccountRelations.delete operationId: Contact_removeById description: Removes GhostContactAccountRelation with given id parameters: - description: ID of GhostContactAccountRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response12' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o79npk1136ptp patch: tags: - Contact summary: GhostContactAccountRelations.update operationId: Contact_updateRelation description: >- Modifies GhostContactAccountRelation or GhostContactAccountRelations with given id(s) parameters: - description: ID of GhostContactAccountRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostContactAccountRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting GhostContactAccountRelation content: application/json: schema: $ref: '#/components/schemas/ContactUpdateRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1hryaxrhhhx7n /entities/GhostContactAccountRelations: get: tags: - Contact summary: GhostContactAccountRelations.list operationId: Contact_getAllRelations description: Returns all defined GhostContactAccountRelations parameters: - description: >- if enabled, deleted GhostContactAccountRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of GhostContactAccountRelations content: application/json: schema: $ref: '#/components/schemas/ContactGetAllRelations200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xu4iqoht5vkg8 post: tags: - Contact summary: GhostContactAccountRelations.create operationId: Contact_createRelation description: Creates new GhostContactAccountRelation parameters: - description: >- Specify validation level of GhostContactAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostContactAccountRelationInput' responses: '201': description: Creation confirmation. Returns created GhostContactAccountRelation content: application/json: schema: $ref: '#/components/schemas/ContactCreateRelation201Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5hvj1nnrsjpi3 /entities/GhostContactAccountRelations/batch-delete: post: tags: - Contact summary: GhostContactAccountRelations.batch_delete operationId: Contact_removeBatchGhostContactRelations description: Removes GhostContactAccountRelations with given list of ids parameters: - description: >- Specify validation level of GhostContactAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/ContactRemoveBatchGhostContactRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ContactRemoveBatchGhostContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kvaikt0gvwel2 /entities/GhostContactAccountRelations/batch-modify: post: tags: - Contact summary: GhostContactAccountRelations.batch_create_or_update operationId: Contact_createOrUpdateBatchRelations description: Create or update an batch of GhostContactAccountRelations parameters: - description: >- Specify validation level of GhostContactAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/ContactCreateOrUpdateBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated GhostContactAccountRelations content: application/json: schema: $ref: >- #/components/schemas/ContactCreateOrUpdateBatchRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wf3ktvkkrfo11 /entities/GhostLeadOpptyContactRelations/{id}: get: tags: - Contact summary: GhostLeadOpptyContactRelations.get operationId: Contact_getById description: Returns GhostLeadOpptyContactRelation with given id parameters: - description: ID of GhostLeadOpptyContactRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: GhostLeadOpptyContactRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response13' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sgfqspr2byquq delete: tags: - Contact summary: GhostLeadOpptyContactRelations.delete operationId: Contact_removeById description: Removes GhostLeadOpptyContactRelation with given id parameters: - description: ID of GhostLeadOpptyContactRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostLeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response13' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1hip4am2je3qj patch: tags: - Contact summary: GhostLeadOpptyContactRelations.update operationId: Contact_modifyRelationWithId description: >- Modifies GhostLeadOpptyContactRelation or GhostLeadOpptyContactRelations with given id(s) parameters: - description: ID of GhostLeadOpptyContactRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostLeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostLeadOpptyContactRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting GhostLeadOpptyContactRelation content: application/json: schema: $ref: '#/components/schemas/ContactModifyRelationWithIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r84bw4z4fhzfk /entities/GhostLeadOpptyContactRelations: get: tags: - Contact summary: GhostLeadOpptyContactRelations.list operationId: Contact_listGhostLeadOpptyContactRelations description: Returns all defined GhostLeadOpptyContactRelations parameters: - description: >- if enabled, deleted GhostLeadOpptyContactRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of GhostLeadOpptyContactRelations content: application/json: schema: $ref: >- #/components/schemas/ContactListGhostLeadOpptyContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f9qjhf3g8o77i post: tags: - Contact summary: GhostLeadOpptyContactRelations.create operationId: Contact_createGhostLeadOpptyContactRelation description: Creates new GhostLeadOpptyContactRelation parameters: - description: >- Specify validation level of GhostLeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostLeadOpptyContactRelationInput' responses: '201': description: Creation confirmation. Returns created GhostLeadOpptyContactRelation content: application/json: schema: $ref: >- #/components/schemas/ContactCreateGhostLeadOpptyContactRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 65oe613s6z3o9 /entities/GhostLeadOpptyContactRelations/batch-delete: post: tags: - Contact summary: GhostLeadOpptyContactRelations.batch_delete operationId: Contact_removeByIds description: Removes GhostLeadOpptyContactRelations with given list of ids parameters: - description: >- Specify validation level of GhostLeadOpptyContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ContactRemoveByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mcm9p9nebo6r6 /entities/GhostLeadOpptyContactRelations/batch-modify: post: tags: - Contact summary: GhostLeadOpptyContactRelations.batch_create_or_update operationId: Contact_modifyBatchGhostLeadOpptyContactRelations description: Create or update an batch of GhostLeadOpptyContactRelations parameters: - description: >- Specify validation level of GhostLeadOpptyContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactRelation required: true content: application / json: schema: $ref: >- #/components/schemas/ContactModifyBatchGhostLeadOpptyContactRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactRelations content: application/json: schema: $ref: >- #/components/schemas/ContactModifyBatchGhostLeadOpptyContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: opoz5iqbd1rpo /entities/GhostLeadOpptyContactSalesRoleRelations/{id}: get: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.get operationId: Contact_getById description: Returns GhostLeadOpptyContactSalesRoleRelation with given id parameters: - description: ID of GhostLeadOpptyContactSalesRoleRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: GhostLeadOpptyContactSalesRoleRelation data content: application/json: schema: $ref: '#/components/schemas/ContactGetById200Response14' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 00ep5kg7y23j1 delete: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.delete operationId: Contact_removeById description: Removes GhostLeadOpptyContactSalesRoleRelation with given id parameters: - description: ID of GhostLeadOpptyContactSalesRoleRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostLeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById200Response14' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u1gm4bqrtwy6e patch: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.update operationId: Contact_updateGhostLeadOpptyContactSalesRoleRelation description: >- Modifies GhostLeadOpptyContactSalesRoleRelation or GhostLeadOpptyContactSalesRoleRelations with given id(s) parameters: - description: ID of GhostLeadOpptyContactSalesRoleRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of GhostLeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateGhostLeadOpptyContactSalesRoleRelationInput responses: '200': description: >- Modification confirmation. Returns resulting GhostLeadOpptyContactSalesRoleRelation content: application/json: schema: $ref: >- #/components/schemas/ContactUpdateGhostLeadOpptyContactSalesRoleRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jl2ae3g71gmz1 /entities/GhostLeadOpptyContactSalesRoleRelations: get: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.list operationId: Contact_listDefinedRelations description: Returns all defined GhostLeadOpptyContactSalesRoleRelations parameters: - description: >- if enabled, deleted GhostLeadOpptyContactSalesRoleRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of GhostLeadOpptyContactSalesRoleRelations content: application/json: schema: $ref: '#/components/schemas/ContactListDefinedRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ikk4qwxq11blt post: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.create operationId: Contact_createNewGhostLeadOpptyContactSalesRoleRelation description: Creates new GhostLeadOpptyContactSalesRoleRelation parameters: - description: >- Specify validation level of GhostLeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createGhostLeadOpptyContactSalesRoleRelationInput responses: '201': description: >- Creation confirmation. Returns created GhostLeadOpptyContactSalesRoleRelation content: application/json: schema: $ref: >- #/components/schemas/ContactCreateNewGhostLeadOpptyContactSalesRoleRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0pwevzgz5jtl9 /entities/GhostLeadOpptyContactSalesRoleRelations/batch-delete: post: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.batch_delete operationId: Contact_removeBatchGhostLeadOpptySalesRoleRelations description: Removes GhostLeadOpptyContactSalesRoleRelations with given list of ids parameters: - description: >- Specify validation level of GhostLeadOpptyContactSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/ContactRemoveBatchGhostLeadOpptySalesRoleRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ContactRemoveBatchGhostLeadOpptySalesRoleRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2uf5dwzcbs9q4 /entities/GhostLeadOpptyContactSalesRoleRelations/batch-modify: post: tags: - Contact summary: GhostLeadOpptyContactSalesRoleRelations.batch_create_or_update operationId: Contact_modifyBatchGhostLeadOpptySalesRoleRelations description: Create or update an batch of GhostLeadOpptyContactSalesRoleRelations parameters: - description: >- Specify validation level of GhostLeadOpptyContactSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/ContactModifyBatchGhostLeadOpptySalesRoleRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactSalesRoleRelations content: application/json: schema: $ref: >- #/components/schemas/ContactModifyBatchGhostLeadOpptySalesRoleRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xza6r13ciw04j /entities/ImportMappingMasks/{id}: get: tags: - Import summary: ImportMappingMasks.get operationId: Import_mappingMaskGet description: Returns ImportMappingMask with given id parameters: - description: ID of ImportMappingMask to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ImportMappingMask data content: application/json: schema: $ref: '#/components/schemas/ImportMappingMaskGetResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 80d0y91er6yez delete: tags: - Import summary: ImportMappingMasks.delete operationId: Import_mappingMaskremoveById description: Removes ImportMappingMask with given id parameters: - description: ID of ImportMappingMask to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ImportMappingMask 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ImportMappingMaskremoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: t8b1bp33ty1ba patch: tags: - Import summary: ImportMappingMasks.update operationId: Import_modifyMappingMask description: Modifies ImportMappingMask or ImportMappingMasks with given id(s) parameters: - description: ID of ImportMappingMask to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ImportMappingMask 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateImportMappingMaskInput' responses: '200': description: Modification confirmation. Returns resulting ImportMappingMask content: application/json: schema: $ref: '#/components/schemas/ImportModifyMappingMaskResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aufb6y94kcvfg /entities/ImportMappingMasks: get: tags: - Import summary: ImportMappingMasks.list operationId: Import_mappingMasksList description: Returns all defined ImportMappingMasks parameters: - description: if enabled, deleted ImportMappingMasks are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ImportMappingMasks content: application/json: schema: $ref: '#/components/schemas/ImportMappingMasksListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 82vkmynl3mfos post: tags: - Import summary: ImportMappingMasks.create operationId: Import_mappingMaskCreate description: Creates new ImportMappingMask parameters: - description: >- Specify validation level of ImportMappingMask 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ImportMappingMask required: true content: application / json: schema: $ref: '#/components/schemas/createImportMappingMaskInput' responses: '201': description: Creation confirmation. Returns created ImportMappingMask content: application/json: schema: $ref: '#/components/schemas/ImportMappingMaskCreateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gr2owdmkvhbu1 /entities/ImportMappingMasks/batch-delete: post: tags: - Import summary: ImportMappingMasks.batch_delete operationId: Import_mappingMasksremoveBatch description: Removes ImportMappingMasks with given list of ids parameters: - description: >- Specify validation level of ImportMappingMasks 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ImportMappingMasksremoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ImportMappingMasksremoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: akh00dgj4dn0w /entities/ImportMappingMasks/batch-modify: post: tags: - Import summary: ImportMappingMasks.batch_create_or_update operationId: Import_mappingBatchCreateOrUpdate description: Create or update an batch of ImportMappingMasks parameters: - description: >- Specify validation level of ImportMappingMasks 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ImportMappingMask required: true content: application / json: schema: $ref: '#/components/schemas/ImportMappingBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ImportMappingMasks content: application/json: schema: $ref: '#/components/schemas/ImportMappingBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b8hc3awu4osel /entities/InterfacePreviews/{id}: get: tags: - Interface summary: InterfacePreviews.get operationId: Interface_getById description: Returns InterfacePreview with given id parameters: - description: ID of InterfacePreview to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: InterfacePreview data content: application/json: schema: $ref: '#/components/schemas/InterfaceGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1j4sg3idp3ape delete: tags: - Interface summary: InterfacePreviews.delete operationId: Interface_removeById description: Removes InterfacePreview with given id parameters: - description: ID of InterfacePreview to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of InterfacePreview 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/InterfaceRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pxi4ss5uufqb8 patch: tags: - Interface summary: InterfacePreviews.update operationId: Interface_modifyById description: Modifies InterfacePreview or InterfacePreviews with given id(s) parameters: - description: ID of InterfacePreview to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of InterfacePreview 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateInterfacePreviewInput' responses: '200': description: Modification confirmation. Returns resulting InterfacePreview content: application/json: schema: $ref: '#/components/schemas/InterfaceModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ep6sobvld9by4 /entities/InterfacePreviews: get: tags: - Interface summary: InterfacePreviews.list operationId: Interface_getAllPreviews description: Returns all defined InterfacePreviews parameters: - description: if enabled, deleted InterfacePreviews are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of InterfacePreviews content: application/json: schema: $ref: '#/components/schemas/InterfaceGetAllPreviewsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ta52fupwa6off post: tags: - Interface summary: InterfacePreviews.create operationId: Interface_generatePreview description: Creates new InterfacePreview parameters: - description: >- Specify validation level of InterfacePreview 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new InterfacePreview required: true content: application / json: schema: $ref: '#/components/schemas/createInterfacePreviewInput' responses: '201': description: Creation confirmation. Returns created InterfacePreview content: application/json: schema: $ref: '#/components/schemas/InterfaceGeneratePreviewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iv7pkjrkrip65 /entities/InterfacePreviews/batch-delete: post: tags: - Interface summary: InterfacePreviews.batch_delete operationId: Interface_removeWithIds description: Removes InterfacePreviews with given list of ids parameters: - description: >- Specify validation level of InterfacePreviews 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for InterfacePreviews. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/InterfaceRemoveWithIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/InterfaceRemoveWithIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xs6l2b4nekqpt /entities/InterfacePreviews/batch-modify: post: tags: - Interface summary: InterfacePreviews.batch_create_or_update operationId: Interface_modifyBatchInterfacePreviews description: Create or update an batch of InterfacePreviews parameters: - description: >- Specify validation level of InterfacePreviews 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for InterfacePreviews. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new InterfacePreview required: true content: application / json: schema: $ref: >- #/components/schemas/InterfaceModifyBatchInterfacePreviewsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated InterfacePreviews content: application/json: schema: $ref: >- #/components/schemas/InterfaceModifyBatchInterfacePreviewsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hnu9nn4muysbf /entities/Leads/{id}: get: tags: - Lead & Opportunity summary: Leads.get operationId: LeadOpportunity_getLeadById description: Returns Lead with given id parameters: - description: ID of Lead to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Lead data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetLeadByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l2ilij9x6u4u4 delete: tags: - Lead & Opportunity summary: Leads.delete operationId: LeadOpportunity_removeLeadById description: Removes Lead with given id parameters: - description: ID of Lead to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Lead 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveLeadByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ku4se4uh1gwk patch: tags: - Lead & Opportunity summary: Leads.update operationId: LeadOpportunity_modifyLead description: Modifies Lead or Leads with given id(s) parameters: - description: ID of Lead to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Lead 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadInput' responses: '200': description: Modification confirmation. Returns resulting Lead content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyLeadResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9l16sqpyvhsws /entities/Leads: get: tags: - Lead & Opportunity summary: Leads.list operationId: LeadOpportunity_getAllLeads description: Returns all defined Leads parameters: - description: if enabled, deleted Leads are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Leads content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetAllLeadsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a4virul3yztsl post: tags: - Lead & Opportunity summary: Leads.create operationId: LeadOpportunity_registerNewLead description: Creates new Lead parameters: - description: >- Specify validation level of Lead 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Lead required: true content: application / json: schema: $ref: '#/components/schemas/createLeadInput' responses: '201': description: Creation confirmation. Returns created Lead content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRegisterNewLeadResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4zr2crwmh3503 /entities/Leads/batch-delete: post: tags: - Lead & Opportunity summary: Leads.batch_delete operationId: LeadOpportunity_removeBatch description: Removes Leads with given list of ids parameters: - description: >- Specify validation level of Leads 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ryeffwc3kshn6 /entities/Leads/batch-modify: post: tags: - Lead & Opportunity summary: Leads.batch_create_or_update operationId: LeadOpportunity_modifyBatchLeads description: Create or update an batch of Leads parameters: - description: >- Specify validation level of Leads 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Lead required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityModifyBatchLeadsRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Leads content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyBatchLeadsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xyr5orsgd7zuv /entities/LeadOppties/{id}: get: tags: - Lead & Opportunity summary: LeadOppties.get operationId: LeadOpportunity_getById description: Returns LeadOppty with given id parameters: - description: ID of LeadOppty to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOppty data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fo7y4fulidwsm /entities/LeadOppties: get: tags: - Lead & Opportunity summary: LeadOppties.list operationId: LeadOpportunity_getAllLeadOpportunities description: Returns all defined LeadOppties parameters: - description: if enabled, deleted LeadOppties are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOppties content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllLeadOpportunitiesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v9jg52a6sj4c6 /entities/LeadOpptyAccountRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptyAccountRelation with given id parameters: - description: ID of LeadOpptyAccountRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyAccountRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eujddx6kcxuke delete: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyAccountRelation with given id parameters: - description: ID of LeadOpptyAccountRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l2mlgnz5zx1op patch: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.update operationId: LeadOpportunity_modifyRelation description: >- Modifies LeadOpptyAccountRelation or LeadOpptyAccountRelations with given id(s) parameters: - description: ID of LeadOpptyAccountRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyAccountRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptyAccountRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gqtdpd918ek55 /entities/LeadOpptyAccountRelations: get: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.list operationId: LeadOpportunity_getList description: Returns all defined LeadOpptyAccountRelations parameters: - description: if enabled, deleted LeadOpptyAccountRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyAccountRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sak3t5zv7r2jp post: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.create operationId: LeadOpportunity_createNewRelation description: Creates new LeadOpptyAccountRelation parameters: - description: >- Specify validation level of LeadOpptyAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyAccountRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyAccountRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityCreateNewRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0dd7ublx8tz9u /entities/LeadOpptyAccountRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.batch_delete operationId: LeadOpportunity_removeByIds description: Removes LeadOpptyAccountRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptyAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qp0v29y0y3pbb /entities/LeadOpptyAccountRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyAccountRelations.batch_create_or_update operationId: LeadOpportunity_modifyBatchLeadOpptyAccountRelations description: Create or update an batch of LeadOpptyAccountRelations parameters: - description: >- Specify validation level of LeadOpptyAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyAccountRelation required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchLeadOpptyAccountRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyAccountRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchLeadOpptyAccountRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 11wow8s9caupv /entities/LeadOpptyContactGroupRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptyContactGroupRelation with given id parameters: - description: ID of LeadOpptyContactGroupRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactGroupRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xys3ebk72rccr delete: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyContactGroupRelation with given id parameters: - description: ID of LeadOpptyContactGroupRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactGroupRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6yacgvkd6wj8n patch: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.update operationId: LeadOpportunity_modifyRelation description: >- Modifies LeadOpptyContactGroupRelation or LeadOpptyContactGroupRelations with given id(s) parameters: - description: ID of LeadOpptyContactGroupRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactGroupRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyContactGroupRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptyContactGroupRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kh30vjlb06ig7 /entities/LeadOpptyContactGroupRelations: get: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.list operationId: LeadOpportunity_getAllRelations description: Returns all defined LeadOpptyContactGroupRelations parameters: - description: >- if enabled, deleted LeadOpptyContactGroupRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactGroupRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fu3hci5re37ca post: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.create operationId: LeadOpportunity_createNewRelation description: Creates new LeadOpptyContactGroupRelation parameters: - description: >- Specify validation level of LeadOpptyContactGroupRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactGroupRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyContactGroupRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyContactGroupRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewRelation201Response '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4gneuqgmhv2a0 /entities/LeadOpptyContactGroupRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadOpptyContactGroupRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptyContactGroupRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zojyumvn2j293 /entities/LeadOpptyContactGroupRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyContactGroupRelations.batch_create_or_update operationId: LeadOpportunity_batchModifyLeadOpptyContactGroupRelations description: Create or update an batch of LeadOpptyContactGroupRelations parameters: - description: >- Specify validation level of LeadOpptyContactGroupRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactGroupRelation required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyLeadOpptyContactGroupRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyContactGroupRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyLeadOpptyContactGroupRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hk7z9tdy11zty /entities/LeadOpptyContactRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptyContactRelation with given id parameters: - description: ID of LeadOpptyContactRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p6yyr3s1jau8s delete: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyContactRelation with given id parameters: - description: ID of LeadOpptyContactRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kj85son80ynvh patch: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.update operationId: LeadOpportunity_modifyRelation description: >- Modifies LeadOpptyContactRelation or LeadOpptyContactRelations with given id(s) parameters: - description: ID of LeadOpptyContactRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyContactRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptyContactRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyRelation200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wioiwkq1mji9q /entities/LeadOpptyContactRelations: get: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.list operationId: LeadOpportunity_getAllRelations description: Returns all defined LeadOpptyContactRelations parameters: - description: if enabled, deleted LeadOpptyContactRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetAllRelations200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5a9vns4wwlz53 post: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.create operationId: LeadOpportunity_createNewRelation description: Creates new LeadOpptyContactRelation parameters: - description: >- Specify validation level of LeadOpptyContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyContactRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyContactRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewRelation201Response1 '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dy1uqm05ls9dl /entities/LeadOpptyContactRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.batch_delete operationId: LeadOpportunity_removeByIds description: Removes LeadOpptyContactRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptyContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l0mujl61kiozw /entities/LeadOpptyContactRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyContactRelations.batch_create_or_update operationId: LeadOpportunity_modifyBatchLeadOpptyContactRelations description: Create or update an batch of LeadOpptyContactRelations parameters: - description: >- Specify validation level of LeadOpptyContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactRelation required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchLeadOpptyContactRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyContactRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchLeadOpptyContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c4x09pe3pzbwp /entities/LeadOpptyContactSalesRoleRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptyContactSalesRoleRelation with given id parameters: - description: ID of LeadOpptyContactSalesRoleRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactSalesRoleRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mxk9miwee0a43 delete: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyContactSalesRoleRelation with given id parameters: - description: ID of LeadOpptyContactSalesRoleRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7o5tkr2zzw0i8 patch: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.update operationId: LeadOpportunity_modifyContactSalesRoleRelation description: >- Modifies LeadOpptyContactSalesRoleRelation or LeadOpptyContactSalesRoleRelations with given id(s) parameters: - description: ID of LeadOpptyContactSalesRoleRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateLeadOpptyContactSalesRoleRelationInput responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptyContactSalesRoleRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyContactSalesRoleRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uiguzq3wx3k7w /entities/LeadOpptyContactSalesRoleRelations: get: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.list operationId: LeadOpportunity_getRelations description: Returns all defined LeadOpptyContactSalesRoleRelations parameters: - description: >- if enabled, deleted LeadOpptyContactSalesRoleRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactSalesRoleRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: haby8i1c4smb0 post: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.create operationId: LeadOpportunity_createNewLeadOpptyContactSalesRoleRelation description: Creates new LeadOpptyContactSalesRoleRelation parameters: - description: >- Specify validation level of LeadOpptyContactSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createLeadOpptyContactSalesRoleRelationInput responses: '201': description: >- Creation confirmation. Returns created LeadOpptyContactSalesRoleRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewLeadOpptyContactSalesRoleRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3yj5rii9sm459 /entities/LeadOpptyContactSalesRoleRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.batch_delete operationId: LeadOpportunity_removeRelations description: Removes LeadOpptyContactSalesRoleRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptyContactSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5cy3kjmlrcpox /entities/LeadOpptyContactSalesRoleRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyContactSalesRoleRelations.batch_create_or_update operationId: LeadOpportunity_batchModify description: Create or update an batch of LeadOpptyContactSalesRoleRelations parameters: - description: >- Specify validation level of LeadOpptyContactSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyContactSalesRoleRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hsyby7ep17el0 /entities/LeadOpptyDataExRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyDataExRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptyDataExRelation with given id parameters: - description: ID of LeadOpptyDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyDataExRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 082607qldcylg /entities/LeadOpptyDataExRelations: get: tags: - Lead & Opportunity summary: LeadOpptyDataExRelations.list operationId: LeadOpportunity_getAllRelations description: Returns all defined LeadOpptyDataExRelations parameters: - description: if enabled, deleted LeadOpptyDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyDataExRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllRelations200Response1 '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qc6knii5ssew0 /entities/LeadOpptyKPIs/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyKPIs.get operationId: LeadOpportunity_getById description: Returns LeadOpptyKPI with given id parameters: - description: ID of LeadOpptyKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyKPI data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4cbhtbfcnaiv6 delete: tags: - Lead & Opportunity summary: LeadOpptyKPIs.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyKPI with given id parameters: - description: ID of LeadOpptyKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyKPI 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cl3tgn29s3l07 patch: tags: - Lead & Opportunity summary: LeadOpptyKPIs.update operationId: LeadOpportunity_modifyKpi description: Modifies LeadOpptyKPI or LeadOpptyKPIs with given id(s) parameters: - description: ID of LeadOpptyKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyKPIInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyKPI content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyKpiResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8pifprrkdjjhk /entities/LeadOpptyKPIs: get: tags: - Lead & Opportunity summary: LeadOpptyKPIs.list operationId: LeadOpportunity_getAllKpis description: Returns all defined LeadOpptyKPIs parameters: - description: if enabled, deleted LeadOpptyKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyKPIs content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g532nwk9gjmk6 post: tags: - Lead & Opportunity summary: LeadOpptyKPIs.create operationId: LeadOpportunity_createNewLeadOpptyKPI description: Creates new LeadOpptyKPI parameters: - description: >- Specify validation level of LeadOpptyKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyKPI required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyKPIInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyKPI content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewLeadOpptyKpiResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: shhw993a33noh /entities/LeadOpptyKPIs/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyKPIs.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadOpptyKPIs with given list of ids parameters: - description: >- Specify validation level of LeadOpptyKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ue24y7tmvt42o /entities/LeadOpptyKPIs/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyKPIs.batch_create_or_update operationId: LeadOpportunity_batchModify description: Create or update an batch of LeadOpptyKPIs parameters: - description: >- Specify validation level of LeadOpptyKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyKPI required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyKPIs content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModify200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r7wraew7khaoi /entities/LeadOpptySharingClientRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.get operationId: LeadOpportunity_getById description: Returns LeadOpptySharingClientRelation with given id parameters: - description: ID of LeadOpptySharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptySharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oekfe4e8o1vcn delete: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptySharingClientRelation with given id parameters: - description: ID of LeadOpptySharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptySharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v8ufsv6hpmwxy patch: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.update operationId: LeadOpportunity_modifyRelation description: >- Modifies LeadOpptySharingClientRelation or LeadOpptySharingClientRelations with given id(s) parameters: - description: ID of LeadOpptySharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptySharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptySharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptySharingClientRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyRelation200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: reryj2aez9zww /entities/LeadOpptySharingClientRelations: get: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.list operationId: LeadOpportunity_getAllClientRelations description: Returns all defined LeadOpptySharingClientRelations parameters: - description: >- if enabled, deleted LeadOpptySharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptySharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9guzvut6re1z7 post: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.create operationId: LeadOpportunity_createNewRelation description: Creates new LeadOpptySharingClientRelation parameters: - description: >- Specify validation level of LeadOpptySharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptySharingClientRelationInput' responses: '201': description: >- Creation confirmation. Returns created LeadOpptySharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewRelation201Response2 '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2gg24don8e84p /entities/LeadOpptySharingClientRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadOpptySharingClientRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptySharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wltnkcefe1m2j /entities/LeadOpptySharingClientRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptySharingClientRelations.batch_create_or_update operationId: LeadOpportunity_batchModify description: Create or update an batch of LeadOpptySharingClientRelations parameters: - description: >- Specify validation level of LeadOpptySharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyRequest2' responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptySharingClientRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModify200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 29ydlkyks6sup /entities/LeadOpptySharingSalesUnitRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.get operationId: LeadOpportunity_getSalesUnitRelation description: Returns LeadOpptySharingSalesUnitRelation with given id parameters: - description: ID of LeadOpptySharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptySharingSalesUnitRelation data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetSalesUnitRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 669jraym85vq5 delete: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptySharingSalesUnitRelation with given id parameters: - description: ID of LeadOpptySharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptySharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c7erx5rs2sshq patch: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.update operationId: LeadOpportunity_updateRelation description: >- Modifies LeadOpptySharingSalesUnitRelation or LeadOpptySharingSalesUnitRelations with given id(s) parameters: - description: ID of LeadOpptySharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptySharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateLeadOpptySharingSalesUnitRelationInput responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptySharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: asvpsnoxal27e /entities/LeadOpptySharingSalesUnitRelations: get: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.list operationId: LeadOpportunity_getRelations description: Returns all defined LeadOpptySharingSalesUnitRelations parameters: - description: >- if enabled, deleted LeadOpptySharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptySharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetRelations200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c1zls54p9wgmg post: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.create operationId: LeadOpportunity_createNewRelation description: Creates new LeadOpptySharingSalesUnitRelation parameters: - description: >- Specify validation level of LeadOpptySharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createLeadOpptySharingSalesUnitRelationInput responses: '201': description: >- Creation confirmation. Returns created LeadOpptySharingSalesUnitRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewRelation201Response3 '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pnkudkx3l6ei8 /entities/LeadOpptySharingSalesUnitRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadOpptySharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptySharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest4' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1ahnmmn57xx4d /entities/LeadOpptySharingSalesUnitRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptySharingSalesUnitRelations.batch_create_or_update operationId: LeadOpportunity_batchModifySalesUnitRelations description: Create or update an batch of LeadOpptySharingSalesUnitRelations parameters: - description: >- Specify validation level of LeadOpptySharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifySalesUnitRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptySharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifySalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xfzanp0jtpoxe /entities/LeadOpptyStepCheckListRelations/{id}: get: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.get operationId: LeadOpportunity_getRelationById description: Returns LeadOpptyStepCheckListRelation with given id parameters: - description: ID of LeadOpptyStepCheckListRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadOpptyStepCheckListRelation data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetRelationByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ec0e645cf2gl delete: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.delete operationId: LeadOpportunity_removeById description: Removes LeadOpptyStepCheckListRelation with given id parameters: - description: ID of LeadOpptyStepCheckListRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyStepCheckListRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zvur8pibbswfj patch: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.update operationId: LeadOpportunity_modifyCheckListRelation description: >- Modifies LeadOpptyStepCheckListRelation or LeadOpptyStepCheckListRelations with given id(s) parameters: - description: ID of LeadOpptyStepCheckListRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadOpptyStepCheckListRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyStepCheckListRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting LeadOpptyStepCheckListRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyCheckListRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fuv8kf85moaxy /entities/LeadOpptyStepCheckListRelations: get: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.list operationId: LeadOpportunity_getAllRelations description: Returns all defined LeadOpptyStepCheckListRelations parameters: - description: >- if enabled, deleted LeadOpptyStepCheckListRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyStepCheckListRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllRelations200Response2 '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4veu8smke3umd post: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.create operationId: LeadOpportunity_createChecklistRelation description: Creates new LeadOpptyStepCheckListRelation parameters: - description: >- Specify validation level of LeadOpptyStepCheckListRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyStepCheckListRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyStepCheckListRelationInput' responses: '201': description: >- Creation confirmation. Returns created LeadOpptyStepCheckListRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateChecklistRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jr4bwdgflj0s1 /entities/LeadOpptyStepCheckListRelations/batch-delete: post: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.batch_delete operationId: LeadOpportunity_removeBatchByIds description: Removes LeadOpptyStepCheckListRelations with given list of ids parameters: - description: >- Specify validation level of LeadOpptyStepCheckListRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ikrdm9b5gnsqm /entities/LeadOpptyStepCheckListRelations/batch-modify: post: tags: - Lead & Opportunity summary: LeadOpptyStepCheckListRelations.batch_create_or_update operationId: LeadOpportunity_batchModifyRelations description: Create or update an batch of LeadOpptyStepCheckListRelations parameters: - description: >- Specify validation level of LeadOpptyStepCheckListRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadOpptyStepCheckListRelation required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadOpptyStepCheckListRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j9zwa4hbbb4qd /entities/LeadProcesses/{id}: get: tags: - Lead & Opportunity summary: LeadProcesses.get operationId: LeadOpportunity_getLeadProcess description: Returns LeadProcess with given id parameters: - description: ID of LeadProcess to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadProcess data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetLeadProcessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7yjdrjoy3ei2g delete: tags: - Lead & Opportunity summary: LeadProcesses.delete operationId: LeadOpportunity_removeLeadProcess description: Removes LeadProcess with given id parameters: - description: ID of LeadProcess to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadProcess 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveLeadProcessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gharhwetnjpih patch: tags: - Lead & Opportunity summary: LeadProcesses.update operationId: LeadOpportunity_modifyLeadProcess description: Modifies LeadProcess or LeadProcesses with given id(s) parameters: - description: ID of LeadProcess to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadProcessInput' responses: '200': description: Modification confirmation. Returns resulting LeadProcess content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyLeadProcessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lxh731r18890p /entities/LeadProcesses: get: tags: - Lead & Opportunity summary: LeadProcesses.list operationId: LeadOpportunity_getAllProcesses description: Returns all defined LeadProcesses parameters: - description: if enabled, deleted LeadProcesses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadProcesses content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetAllProcessesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oi5mfqy08buf5 post: tags: - Lead & Opportunity summary: LeadProcesses.create operationId: LeadOpportunity_createLeadProcess description: Creates new LeadProcess parameters: - description: >- Specify validation level of LeadProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadProcess required: true content: application / json: schema: $ref: '#/components/schemas/createLeadProcessInput' responses: '201': description: Creation confirmation. Returns created LeadProcess content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityCreateLeadProcessResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6a8o5iagkew34 /entities/LeadProcesses/batch-delete: post: tags: - Lead & Opportunity summary: LeadProcesses.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadProcesses with given list of ids parameters: - description: >- Specify validation level of LeadProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest5' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response4' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: evt5f4pxkotaw /entities/LeadProcesses/batch-modify: post: tags: - Lead & Opportunity summary: LeadProcesses.batch_create_or_update operationId: LeadOpportunity_batchModifyLeadProcesses description: Create or update an batch of LeadProcesses parameters: - description: >- Specify validation level of LeadProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadProcess required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyLeadProcessesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated LeadProcesses content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyLeadProcessesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4blgqkbd883yc /entities/LeadTypes/{id}: get: tags: - Lead & Opportunity summary: LeadTypes.get operationId: LeadOpportunity_getLeadType description: Returns LeadType with given id parameters: - description: ID of LeadType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: LeadType data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetLeadTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l5gw5zthkksow delete: tags: - Lead & Opportunity summary: LeadTypes.delete operationId: LeadOpportunity_removeLeadType description: Removes LeadType with given id parameters: - description: ID of LeadType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveLeadTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d4gak88597c2b patch: tags: - Lead & Opportunity summary: LeadTypes.update operationId: LeadOpportunity_modifyLeadType description: Modifies LeadType or LeadTypes with given id(s) parameters: - description: ID of LeadType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of LeadType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadTypeInput' responses: '200': description: Modification confirmation. Returns resulting LeadType content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyLeadTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ryme4tu2i8g1w /entities/LeadTypes: get: tags: - Lead & Opportunity summary: LeadTypes.list operationId: LeadOpportunity_getLeadTypes description: Returns all defined LeadTypes parameters: - description: if enabled, deleted LeadTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadTypes content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetLeadTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ys0jbtyc1yqt8 post: tags: - Lead & Opportunity summary: LeadTypes.create operationId: LeadOpportunity_createLeadType description: Creates new LeadType parameters: - description: >- Specify validation level of LeadType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new LeadType required: true content: application / json: schema: $ref: '#/components/schemas/createLeadTypeInput' responses: '201': description: Creation confirmation. Returns created LeadType content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityCreateLeadTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kyjez281gmbo3 /entities/LeadTypes/batch-delete: post: tags: - Lead & Opportunity summary: LeadTypes.batch_delete operationId: LeadOpportunity_removeBatch description: Removes LeadTypes with given list of ids parameters: - description: >- Specify validation level of LeadTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest6' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response5' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8ysauw19w2xc1 /entities/LeadTypes/batch-modify: post: tags: - Lead & Opportunity summary: LeadTypes.batch_create_or_update operationId: LeadOpportunity_batchModifyLeadTypes description: Create or update an batch of LeadTypes parameters: - description: >- Specify validation level of LeadTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new LeadType required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchModifyLeadTypesRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadTypes content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyLeadTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iqb8w96auef51 /entities/MasterRights/{id}: get: tags: - MasterRight summary: MasterRights.get operationId: MasterRight_getById description: Returns MasterRight with given id parameters: - description: ID of MasterRight to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: MasterRight data content: application/json: schema: $ref: '#/components/schemas/MasterRightGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: skkkrfadt3a0k delete: tags: - MasterRight summary: MasterRights.delete operationId: MasterRight_removeById description: Removes MasterRight with given id parameters: - description: ID of MasterRight to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MasterRight 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o7lqmk95gr7qe patch: tags: - MasterRight summary: MasterRights.update operationId: MasterRight_modifyByIds description: Modifies MasterRight or MasterRights with given id(s) parameters: - description: ID of MasterRight to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MasterRight 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMasterRightInput' responses: '200': description: Modification confirmation. Returns resulting MasterRight content: application/json: schema: $ref: '#/components/schemas/MasterRightModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f75wccklmjyjr /entities/MasterRights: get: tags: - MasterRight summary: MasterRights.list operationId: MasterRight_listAllDefined description: Returns all defined MasterRights parameters: - description: if enabled, deleted MasterRights are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of MasterRights content: application/json: schema: $ref: '#/components/schemas/MasterRightListAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xujoms8d55wjc post: tags: - MasterRight summary: MasterRights.create operationId: MasterRight_generateNewMasterRight description: Creates new MasterRight parameters: - description: >- Specify validation level of MasterRight 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new MasterRight required: true content: application / json: schema: $ref: '#/components/schemas/createMasterRightInput' responses: '201': description: Creation confirmation. Returns created MasterRight content: application/json: schema: $ref: '#/components/schemas/MasterRightGenerateNewMasterRightResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1lw0u1tx6hs36 /entities/MasterRights/batch-delete: post: tags: - MasterRight summary: MasterRights.batch_delete operationId: MasterRight_removeById description: Removes MasterRights with given list of ids parameters: - description: >- Specify validation level of MasterRights 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightRemoveByIdRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MasterRightRemoveById200Response4' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uh876hqjtbpsz /entities/MasterRights/batch-modify: post: tags: - MasterRight summary: MasterRights.batch_create_or_update operationId: MasterRight_modifyBatchMasterRights description: Create or update an batch of MasterRights parameters: - description: >- Specify validation level of MasterRights 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new MasterRight required: true content: application / json: schema: $ref: '#/components/schemas/MasterRightModifyBatchMasterRightsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated MasterRights content: application/json: schema: $ref: >- #/components/schemas/MasterRightModifyBatchMasterRightsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: re4n7eyg7aept /entities/Memos/{id}: get: tags: - Memo summary: Memos.get operationId: Memo_getById description: Returns Memo with given id parameters: - description: ID of Memo to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Memo data content: application/json: schema: $ref: '#/components/schemas/MemoGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gzdd2whhj6tq1 delete: tags: - Memo summary: Memos.delete operationId: Memo_removeById description: Removes Memo with given id parameters: - description: ID of Memo to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Memo 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MemoRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: epozpndujo9z9 patch: tags: - Memo summary: Memos.update operationId: Memo_modifyById description: Modifies Memo or Memos with given id(s) parameters: - description: ID of Memo to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Memo 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMemoInput' responses: '200': description: Modification confirmation. Returns resulting Memo content: application/json: schema: $ref: '#/components/schemas/MemoModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y010nn0jkabqx /entities/Memos: get: tags: - Memo summary: Memos.list operationId: Memo_getAllDefined description: Returns all defined Memos parameters: - description: if enabled, deleted Memos are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Memos content: application/json: schema: $ref: '#/components/schemas/MemoGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fwgsr3vbvtdea post: tags: - Memo summary: Memos.create operationId: Memo_addNew description: Creates new Memo parameters: - description: >- Specify validation level of Memo 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Memo required: true content: application / json: schema: $ref: '#/components/schemas/createMemoInput' responses: '201': description: Creation confirmation. Returns created Memo content: application/json: schema: $ref: '#/components/schemas/MemoAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ela8dubpymtk0 /entities/Memos/batch-delete: post: tags: - Memo summary: Memos.batch_delete operationId: Memo_removeById description: Removes Memos with given list of ids parameters: - description: >- Specify validation level of Memos 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Memos. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MemoRemoveByIdRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MemoRemoveById200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i5jbaqn58iqn2 /entities/Memos/batch-modify: post: tags: - Memo summary: Memos.batch_create_or_update operationId: Memo_batchModify description: Create or update an batch of Memos parameters: - description: >- Specify validation level of Memos 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Memos. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Memo required: true content: application / json: schema: $ref: '#/components/schemas/MemoBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Memos content: application/json: schema: $ref: '#/components/schemas/MemoBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j3mbupqdoaiud /entities/MemoComments/{id}: get: tags: - Memo summary: MemoComments.get operationId: Memo_getById description: Returns MemoComment with given id parameters: - description: ID of MemoComment to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: MemoComment data content: application/json: schema: $ref: '#/components/schemas/MemoGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3lakpgxjst0e0 delete: tags: - Memo summary: MemoComments.delete operationId: Memo_removeById description: Removes MemoComment with given id parameters: - description: ID of MemoComment to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MemoComment 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MemoRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9lrnlbcl3vb01 patch: tags: - Memo summary: MemoComments.update operationId: Memo_updateMemoComment description: Modifies MemoComment or MemoComments with given id(s) parameters: - description: ID of MemoComment to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MemoComment 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMemoCommentInput' responses: '200': description: Modification confirmation. Returns resulting MemoComment content: application/json: schema: $ref: '#/components/schemas/MemoUpdateMemoCommentResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1gcz27lut40zq /entities/MemoComments: get: tags: - Memo summary: MemoComments.list operationId: Memo_getAllMemoComments description: Returns all defined MemoComments parameters: - description: if enabled, deleted MemoComments are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of MemoComments content: application/json: schema: $ref: '#/components/schemas/MemoGetAllMemoCommentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8j4kcz627kf2a post: tags: - Memo summary: MemoComments.create operationId: Memo_createNewMemoComment description: Creates new MemoComment parameters: - description: >- Specify validation level of MemoComment 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new MemoComment required: true content: application / json: schema: $ref: '#/components/schemas/createMemoCommentInput' responses: '201': description: Creation confirmation. Returns created MemoComment content: application/json: schema: $ref: '#/components/schemas/MemoCreateNewMemoCommentResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u4wbonm8dnc9b /entities/MemoComments/batch-delete: post: tags: - Memo summary: MemoComments.batch_delete operationId: Memo_removeByIds description: Removes MemoComments with given list of ids parameters: - description: >- Specify validation level of MemoComments 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MemoComments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MemoRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MemoRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vb070varbrbko /entities/MemoComments/batch-modify: post: tags: - Memo summary: MemoComments.batch_create_or_update operationId: Memo_modifyBatchMemoComments description: Create or update an batch of MemoComments parameters: - description: >- Specify validation level of MemoComments 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MemoComments. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new MemoComment required: true content: application / json: schema: $ref: '#/components/schemas/MemoModifyBatchMemoCommentsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated MemoComments content: application/json: schema: $ref: '#/components/schemas/MemoModifyBatchMemoCommentsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zsgzzcary21k5 /entities/MessageRelations/{id}: get: tags: - Message summary: MessageRelations.get operationId: Message_getById description: Returns MessageRelation with given id parameters: - description: ID of MessageRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: MessageRelation data content: application/json: schema: $ref: '#/components/schemas/MessageGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: h5ceqintl1b3p delete: tags: - Message summary: MessageRelations.delete operationId: Message_removeById description: Removes MessageRelation with given id parameters: - description: ID of MessageRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MessageRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w8kbvjmnb0v6e patch: tags: - Message summary: MessageRelations.update operationId: Message_modifyByIds description: Modifies MessageRelation or MessageRelations with given id(s) parameters: - description: ID of MessageRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMessageRelationInput' responses: '200': description: Modification confirmation. Returns resulting MessageRelation content: application/json: schema: $ref: '#/components/schemas/MessageModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ttjudvua3cvlb /entities/MessageRelations: get: tags: - Message summary: MessageRelations.list operationId: Message_getAllMessageRelations description: Returns all defined MessageRelations parameters: - description: if enabled, deleted MessageRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of MessageRelations content: application/json: schema: $ref: '#/components/schemas/MessageGetAllMessageRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dcm8todiq2v39 post: tags: - Message summary: MessageRelations.create operationId: Message_createNewMessageRelation description: Creates new MessageRelation parameters: - description: >- Specify validation level of MessageRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new MessageRelation required: true content: application / json: schema: $ref: '#/components/schemas/createMessageRelationInput' responses: '201': description: Creation confirmation. Returns created MessageRelation content: application/json: schema: $ref: '#/components/schemas/MessageCreateNewMessageRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sslmhy3hrz114 /entities/MessageRelations/batch-delete: post: tags: - Message summary: MessageRelations.batch_delete operationId: Message_removeBatch description: Removes MessageRelations with given list of ids parameters: - description: >- Specify validation level of MessageRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MessageRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MessageRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tztjtbayz0qwo /entities/MessageRelations/batch-modify: post: tags: - Message summary: MessageRelations.batch_create_or_update operationId: Message_modifyBatchRelations description: Create or update an batch of MessageRelations parameters: - description: >- Specify validation level of MessageRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new MessageRelation required: true content: application / json: schema: $ref: '#/components/schemas/MessageModifyBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated MessageRelations content: application/json: schema: $ref: '#/components/schemas/MessageModifyBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8mxxvscg6s4bx /entities/MessageSharingClientRelations/{id}: get: tags: - Message summary: MessageSharingClientRelations.get operationId: Message_getById description: Returns MessageSharingClientRelation with given id parameters: - description: ID of MessageSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: MessageSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/MessageGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jv8pquqo1fv3e delete: tags: - Message summary: MessageSharingClientRelations.delete operationId: Message_removeById description: Removes MessageSharingClientRelation with given id parameters: - description: ID of MessageSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MessageRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tlzvagwqnm4dn patch: tags: - Message summary: MessageSharingClientRelations.update operationId: Message_updateRelation description: >- Modifies MessageSharingClientRelation or MessageSharingClientRelations with given id(s) parameters: - description: ID of MessageSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMessageSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting MessageSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/MessageUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hbnboe8ftgdql /entities/MessageSharingClientRelations: get: tags: - Message summary: MessageSharingClientRelations.list operationId: Message_getAll description: Returns all defined MessageSharingClientRelations parameters: - description: >- if enabled, deleted MessageSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of MessageSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/MessageGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uwb9h0mssukye post: tags: - Message summary: MessageSharingClientRelations.create operationId: Message_createNewRelation description: Creates new MessageSharingClientRelation parameters: - description: >- Specify validation level of MessageSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new MessageSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createMessageSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created MessageSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/MessageCreateNewRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l7kfjysp15zgt /entities/MessageSharingClientRelations/batch-delete: post: tags: - Message summary: MessageSharingClientRelations.batch_delete operationId: Message_removeBatch description: Removes MessageSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of MessageSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/MessageRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/MessageRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ezr0924ypequ /entities/MessageSharingClientRelations/batch-modify: post: tags: - Message summary: MessageSharingClientRelations.batch_create_or_update operationId: Message_createOrUpdateBatch description: Create or update an batch of MessageSharingClientRelations parameters: - description: >- Specify validation level of MessageSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new MessageSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/MessageCreateOrUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated MessageSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/MessageCreateOrUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w8p8l7qm32zu0 /entities/MessageSharingSalesUnitRelations/{id}: get: tags: - Message summary: MessageSharingSalesUnitRelations.get operationId: Message_getById description: Returns MessageSharingSalesUnitRelation with given id parameters: - description: ID of MessageSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: MessageSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/MessageGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ob73j8an54gsj delete: tags: - Message summary: MessageSharingSalesUnitRelations.delete operationId: Message_removeById description: Removes MessageSharingSalesUnitRelation with given id parameters: - description: ID of MessageSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/MessageRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rmejq8l4rfejw patch: tags: - Message summary: MessageSharingSalesUnitRelations.update operationId: Message_updateById description: >- Modifies MessageSharingSalesUnitRelation or MessageSharingSalesUnitRelations with given id(s) parameters: - description: ID of MessageSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of MessageSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateMessageSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting MessageSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/MessageUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 82jpmm7md7r6r /entities/MessageSharingSalesUnitRelations: get: tags: - Message summary: MessageSharingSalesUnitRelations.list operationId: Message_listRelations description: Returns all defined MessageSharingSalesUnitRelations parameters: - description: >- if enabled, deleted MessageSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of MessageSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/MessageListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lrwpc0ra64lov post: tags: - Message summary: MessageSharingSalesUnitRelations.create operationId: Message_createNewRelation description: Creates new MessageSharingSalesUnitRelation parameters: - description: >- Specify validation level of MessageSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new MessageSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createMessageSharingSalesUnitRelationInput' responses: '201': description: >- Creation confirmation. Returns created MessageSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/MessageCreateNewRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2nibde2ft5h3d /entities/MessageSharingSalesUnitRelations/batch-delete: post: tags: - Message summary: MessageSharingSalesUnitRelations.batch_delete operationId: Message_removeBatchMessageSharingSalesUnitRelations description: Removes MessageSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of MessageSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/MessageRemoveBatchMessageSharingSalesUnitRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/MessageRemoveBatchMessageSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zz7cn7xgt2nbk /entities/MessageSharingSalesUnitRelations/batch-modify: post: tags: - Message summary: MessageSharingSalesUnitRelations.batch_create_or_update operationId: Message_updateBatch description: Create or update an batch of MessageSharingSalesUnitRelations parameters: - description: >- Specify validation level of MessageSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for MessageSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new MessageSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/MessageUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated MessageSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/MessageUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bbaov6nkpwd64 /entities/Notes/{id}: get: tags: - Note summary: Notes.get operationId: Note_getById description: Returns Note with given id parameters: - description: ID of Note to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Note data content: application/json: schema: $ref: '#/components/schemas/NoteGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xv3yr514fqfcf delete: tags: - Note summary: Notes.delete operationId: Note_removeById description: Removes Note with given id parameters: - description: ID of Note to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Note 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/NoteRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7nm7o8g3vh8a9 patch: tags: - Note summary: Notes.update operationId: Note_modifyById description: Modifies Note or Notes with given id(s) parameters: - description: ID of Note to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Note 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateNoteInput' responses: '200': description: Modification confirmation. Returns resulting Note content: application/json: schema: $ref: '#/components/schemas/NoteModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 58rahjyih1am8 /entities/Notes: get: tags: - Note summary: Notes.list operationId: Note_getAll description: Returns all defined Notes parameters: - description: if enabled, deleted Notes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Notes content: application/json: schema: $ref: '#/components/schemas/NoteGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jhbb61ri4f7rn post: tags: - Note summary: Notes.create operationId: Note_addNew description: Creates new Note parameters: - description: >- Specify validation level of Note 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Note required: true content: application / json: schema: $ref: '#/components/schemas/createNoteInput' responses: '201': description: Creation confirmation. Returns created Note content: application/json: schema: $ref: '#/components/schemas/NoteAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8g81jidpndzhl /entities/Notes/batch-delete: post: tags: - Note summary: Notes.batch_delete operationId: Note_removeBatch description: Removes Notes with given list of ids parameters: - description: >- Specify validation level of Notes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Notes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/NoteRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/NoteRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zo8xofmjk0tpz /entities/Notes/batch-modify: post: tags: - Note summary: Notes.batch_create_or_update operationId: Note_batchModify description: Create or update an batch of Notes parameters: - description: >- Specify validation level of Notes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Notes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Note required: true content: application / json: schema: $ref: '#/components/schemas/NoteBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Notes content: application/json: schema: $ref: '#/components/schemas/NoteBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cmztzxms7m0zc /entities/OnlineForms/{id}: get: tags: - Online summary: OnlineForms.get operationId: Online_getById description: Returns OnlineForm with given id parameters: - description: ID of OnlineForm to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineForm data content: application/json: schema: $ref: '#/components/schemas/OnlineGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: drlh6ewa6jvv1 delete: tags: - Online summary: OnlineForms.delete operationId: Online_removeById description: Removes OnlineForm with given id parameters: - description: ID of OnlineForm to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ncf1nacyoz2l3 patch: tags: - Online summary: OnlineForms.update operationId: Online_modifyFormById description: Modifies OnlineForm or OnlineForms with given id(s) parameters: - description: ID of OnlineForm to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: '#/components/schemas/OnlineModifyFormByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rwwmttgaq75lg /entities/OnlineForms: get: tags: - Online summary: OnlineForms.list operationId: Online_getAllForms description: Returns all defined OnlineForms parameters: - description: if enabled, deleted OnlineForms are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineForms content: application/json: schema: $ref: '#/components/schemas/OnlineGetAllFormsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3wc1exluwkusz post: tags: - Online summary: OnlineForms.create operationId: Online_createNewForm description: Creates new OnlineForm parameters: - 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. name: validation-level in: query 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: $ref: '#/components/schemas/OnlineCreateNewFormResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: drvjb2b320zzc /entities/OnlineForms/batch-delete: post: tags: - Online summary: OnlineForms.batch_delete operationId: Online_removeBatchOnlineForms description: Removes OnlineForms with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineForms. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveBatchOnlineFormsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveBatchOnlineFormsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1s4dvb94zxdoa /entities/OnlineForms/batch-modify: post: tags: - Online summary: OnlineForms.batch_create_or_update operationId: Online_modifyBatchOnlineForms description: Create or update an batch of OnlineForms parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineForms. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineForm required: true content: application / json: schema: $ref: '#/components/schemas/OnlineModifyBatchOnlineFormsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineForms content: application/json: schema: $ref: '#/components/schemas/OnlineModifyBatchOnlineFormsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j6c3qigsjuiht /entities/OnlineFormActivityLogLines/{id}: get: tags: - Online summary: OnlineFormActivityLogLines.get operationId: Online_activityLogGetById description: Returns OnlineFormActivityLogLine with given id parameters: - description: ID of OnlineFormActivityLogLine to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineFormActivityLogLine data content: application/json: schema: $ref: '#/components/schemas/OnlineActivityLogGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0xd8wnsdg96xb delete: tags: - Online summary: OnlineFormActivityLogLines.delete operationId: Online_removeById description: Removes OnlineFormActivityLogLine with given id parameters: - description: ID of OnlineFormActivityLogLine to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: a6ku3tnnqfyoa patch: tags: - Online summary: OnlineFormActivityLogLines.update operationId: Online_modifyLogLine description: >- Modifies OnlineFormActivityLogLine or OnlineFormActivityLogLines with given id(s) parameters: - description: ID of OnlineFormActivityLogLine to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: '#/components/schemas/OnlineModifyLogLineResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r16vadurcxhjz /entities/OnlineFormActivityLogLines: get: tags: - Online summary: OnlineFormActivityLogLines.list operationId: Online_listActivityLogLines description: Returns all defined OnlineFormActivityLogLines parameters: - description: if enabled, deleted OnlineFormActivityLogLines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormActivityLogLines content: application/json: schema: $ref: '#/components/schemas/OnlineListActivityLogLinesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l4m5parjfoyae post: tags: - Online summary: OnlineFormActivityLogLines.create operationId: Online_createNewLogLine description: Creates new OnlineFormActivityLogLine parameters: - 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. name: validation-level in: query 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: $ref: '#/components/schemas/OnlineCreateNewLogLineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ruaeqfrlh4xfx /entities/OnlineFormActivityLogLines/batch-delete: post: tags: - Online summary: OnlineFormActivityLogLines.batch_delete operationId: Online_removeByIds description: Removes OnlineFormActivityLogLines with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 60uhf9bqqhnx4 /entities/OnlineFormActivityLogLines/batch-modify: post: tags: - Online summary: OnlineFormActivityLogLines.batch_create_or_update operationId: Online_activityBatchModify description: Create or update an batch of OnlineFormActivityLogLines parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineFormActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/OnlineActivityBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineFormActivityLogLines content: application/json: schema: $ref: '#/components/schemas/OnlineActivityBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hqgigwd5042kh /entities/OnlineFormDataExRelations/{id}: get: tags: - Online summary: OnlineFormDataExRelations.get operationId: Online_formDataExRelationsGet description: Returns OnlineFormDataExRelation with given id parameters: - description: ID of OnlineFormDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineFormDataExRelation data content: application/json: schema: $ref: '#/components/schemas/OnlineFormDataExRelationsGetResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zzil71lernvwy delete: tags: - Online summary: OnlineFormDataExRelations.delete operationId: Online_removeById description: Removes OnlineFormDataExRelation with given id parameters: - description: ID of OnlineFormDataExRelation to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wbb9vcn6b31uy patch: tags: - Online summary: OnlineFormDataExRelations.update operationId: Online_modifyFormDataExRelationsById description: >- Modifies OnlineFormDataExRelation or OnlineFormDataExRelations with given id(s) parameters: - description: ID of OnlineFormDataExRelation to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: >- #/components/schemas/OnlineModifyFormDataExRelationsByIdResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sbyyopxqyxpce /entities/OnlineFormDataExRelations: get: tags: - Online summary: OnlineFormDataExRelations.list operationId: Online_getRelations description: Returns all defined OnlineFormDataExRelations parameters: - description: if enabled, deleted OnlineFormDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormDataExRelations content: application/json: schema: $ref: '#/components/schemas/OnlineGetRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8ondy27f31u3p post: tags: - Online summary: OnlineFormDataExRelations.create operationId: Online_createFormRelation description: Creates new OnlineFormDataExRelation parameters: - 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. name: validation-level in: query 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: $ref: '#/components/schemas/OnlineCreateFormRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5bj5pr84xsguj /entities/OnlineFormDataExRelations/batch-delete: post: tags: - Online summary: OnlineFormDataExRelations.batch_delete operationId: Online_removeBatch description: Removes OnlineFormDataExRelations with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3hwnz3827jr7u /entities/OnlineFormDataExRelations/batch-modify: post: tags: - Online summary: OnlineFormDataExRelations.batch_create_or_update operationId: Online_createOrUpdateBatchOnlineFormDataExRelations description: Create or update an batch of OnlineFormDataExRelations parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineFormDataExRelation required: true content: application / json: schema: $ref: >- #/components/schemas/OnlineCreateOrUpdateBatchOnlineFormDataExRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineFormDataExRelations content: application/json: schema: $ref: >- #/components/schemas/OnlineCreateOrUpdateBatchOnlineFormDataExRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p3pdn44797zlb /entities/OnlineFormRelations/{id}: get: tags: - Online summary: OnlineFormRelations.get operationId: Online_getById description: Returns OnlineFormRelation with given id parameters: - description: ID of OnlineFormRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineFormRelation data content: application/json: schema: $ref: '#/components/schemas/OnlineGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jklj9sqigygpa delete: tags: - Online summary: OnlineFormRelations.delete operationId: Online_removeById description: Removes OnlineFormRelation with given id parameters: - description: ID of OnlineFormRelation to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gajllhg0qldtd patch: tags: - Online summary: OnlineFormRelations.update operationId: Online_modifyRelation description: Modifies OnlineFormRelation or OnlineFormRelations with given id(s) parameters: - description: ID of OnlineFormRelation to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: '#/components/schemas/OnlineModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r2tknyiqlblox /entities/OnlineFormRelations: get: tags: - Online summary: OnlineFormRelations.list operationId: Online_getAllOnlineFormRelations description: Returns all defined OnlineFormRelations parameters: - description: if enabled, deleted OnlineFormRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormRelations content: application/json: schema: $ref: '#/components/schemas/OnlineGetAllOnlineFormRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rcw84b13y9xm1 post: tags: - Online summary: OnlineFormRelations.create operationId: Online_createRelation description: Creates new OnlineFormRelation parameters: - 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. name: validation-level in: query 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: $ref: '#/components/schemas/OnlineCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0vac6mn6h3dsb /entities/OnlineFormRelations/batch-delete: post: tags: - Online summary: OnlineFormRelations.batch_delete operationId: Online_removeBatchByIds description: Removes OnlineFormRelations with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gyc2igdhodaqr /entities/OnlineFormRelations/batch-modify: post: tags: - Online summary: OnlineFormRelations.batch_create_or_update operationId: Online_modifyFormRelationsBatch description: Create or update an batch of OnlineFormRelations parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineFormRelation required: true content: application / json: schema: $ref: '#/components/schemas/OnlineModifyFormRelationsBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineFormRelations content: application/json: schema: $ref: '#/components/schemas/OnlineModifyFormRelationsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 53pswgpxbq6e7 /entities/OnlineFormTypes/{id}: get: tags: - Online summary: OnlineFormTypes.get operationId: Online_getById description: Returns OnlineFormType with given id parameters: - description: ID of OnlineFormType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineFormType data content: application/json: schema: $ref: '#/components/schemas/OnlineGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qzzrlfzi3ewpc delete: tags: - Online summary: OnlineFormTypes.delete operationId: Online_removeById description: Removes OnlineFormType with given id parameters: - description: ID of OnlineFormType to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0qs7a5pzainzd patch: tags: - Online summary: OnlineFormTypes.update operationId: Online_modifyFormType description: Modifies OnlineFormType or OnlineFormTypes with given id(s) parameters: - description: ID of OnlineFormType to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: '#/components/schemas/OnlineModifyFormTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c6994wizfao90 /entities/OnlineFormTypes: get: tags: - Online summary: OnlineFormTypes.list operationId: Online_getAllOnlineFormTypes description: Returns all defined OnlineFormTypes parameters: - description: if enabled, deleted OnlineFormTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormTypes content: application/json: schema: $ref: '#/components/schemas/OnlineGetAllOnlineFormTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x17pjvlgq6abk post: tags: - Online summary: OnlineFormTypes.create operationId: Online_createFormType description: Creates new OnlineFormType parameters: - 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. name: validation-level in: query 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: $ref: '#/components/schemas/OnlineCreateFormTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: di3fya3ehfgzx /entities/OnlineFormTypes/batch-delete: post: tags: - Online summary: OnlineFormTypes.batch_delete operationId: Online_removeByIds description: Removes OnlineFormTypes with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8d19durf5r9vw /entities/OnlineFormTypes/batch-modify: post: tags: - Online summary: OnlineFormTypes.batch_create_or_update operationId: Online_modifyFormBatch description: Create or update an batch of OnlineFormTypes parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineFormType required: true content: application / json: schema: $ref: '#/components/schemas/OnlineModifyFormBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineFormTypes content: application/json: schema: $ref: '#/components/schemas/OnlineModifyFormBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e3xxr9n68kfhp /entities/OnlineFormTypeEmailRelations/{id}: get: tags: - Online summary: OnlineFormTypeEmailRelations.get operationId: Online_formTypeEmailgetById description: Returns OnlineFormTypeEmailRelation with given id parameters: - description: ID of OnlineFormTypeEmailRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OnlineFormTypeEmailRelation data content: application/json: schema: $ref: '#/components/schemas/OnlineFormTypeEmailgetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1e43qmxsgik72 delete: tags: - Online summary: OnlineFormTypeEmailRelations.delete operationId: Online_removeById description: Removes OnlineFormTypeEmailRelation with given id parameters: - description: ID of OnlineFormTypeEmailRelation to delete name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lry65a2rkmc2e patch: tags: - Online summary: OnlineFormTypeEmailRelations.update operationId: Online_updateById description: >- Modifies OnlineFormTypeEmailRelation or OnlineFormTypeEmailRelations with given id(s) parameters: - description: ID of OnlineFormTypeEmailRelation to update name: id in: path required: true schema: type: string format: uuid - 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. name: validation-level in: query schema: type: integer format: int32 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: $ref: '#/components/schemas/OnlineUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uxcu1zqz9zgpf /entities/OnlineFormTypeEmailRelations: get: tags: - Online summary: OnlineFormTypeEmailRelations.list operationId: Online_listOnlineFormTypeEmailRelations description: Returns all defined OnlineFormTypeEmailRelations parameters: - description: >- if enabled, deleted OnlineFormTypeEmailRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormTypeEmailRelations content: application/json: schema: $ref: >- #/components/schemas/OnlineListOnlineFormTypeEmailRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bcloud2wansqa post: tags: - Online summary: OnlineFormTypeEmailRelations.create operationId: Online_createNewOnlineFormTypeEmailRelation description: Creates new OnlineFormTypeEmailRelation parameters: - 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. name: validation-level in: query 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: $ref: >- #/components/schemas/OnlineCreateNewOnlineFormTypeEmailRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8ugt2btxpdxbe /entities/OnlineFormTypeEmailRelations/batch-delete: post: tags: - Online summary: OnlineFormTypeEmailRelations.batch_delete operationId: Online_removeBatchEmailRelations description: Removes OnlineFormTypeEmailRelations with given list of ids parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/OnlineRemoveBatchEmailRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/OnlineRemoveBatchEmailRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rdfn9xj2mt10h /entities/OnlineFormTypeEmailRelations/batch-modify: post: tags: - Online summary: OnlineFormTypeEmailRelations.batch_create_or_update operationId: Online_formTypeEmailRelationsBatchModify description: Create or update an batch of OnlineFormTypeEmailRelations parameters: - 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OnlineFormTypeEmailRelation required: true content: application / json: schema: $ref: >- #/components/schemas/OnlineFormTypeEmailRelationsBatchModifyRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OnlineFormTypeEmailRelations content: application/json: schema: $ref: >- #/components/schemas/OnlineFormTypeEmailRelationsBatchModifyResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9c28u1cqkuvtb /entities/Opportunities/{id}: get: tags: - Lead & Opportunity summary: Opportunities.get operationId: LeadOpportunity_getById description: Returns Opportunity with given id parameters: - description: ID of Opportunity to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Opportunity data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: up8mvnzunvnyc delete: tags: - Lead & Opportunity summary: Opportunities.delete operationId: LeadOpportunity_removeById description: Removes Opportunity with given id parameters: - description: ID of Opportunity to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Opportunity 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fttf3gsu0aa9p patch: tags: - Lead & Opportunity summary: Opportunities.update operationId: LeadOpportunity_modifyOpportunity description: Modifies Opportunity or Opportunities with given id(s) parameters: - description: ID of Opportunity to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Opportunity 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpportunityInput' responses: '200': description: Modification confirmation. Returns resulting Opportunity content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyOpportunityResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3w3xblg5pgmgl /entities/Opportunities: get: tags: - Lead & Opportunity summary: Opportunities.list operationId: LeadOpportunity_getAllOpportunities description: Returns all defined Opportunities parameters: - description: if enabled, deleted Opportunities are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Opportunities content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpportunitiesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 647jwgp2xrp45 post: tags: - Lead & Opportunity summary: Opportunities.create operationId: LeadOpportunity_createNewOpportunity description: Creates new Opportunity parameters: - description: >- Specify validation level of Opportunity 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Opportunity required: true content: application / json: schema: $ref: '#/components/schemas/createOpportunityInput' responses: '201': description: Creation confirmation. Returns created Opportunity content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpportunityResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g7pvjzupuuhtw /entities/Opportunities/batch-delete: post: tags: - Lead & Opportunity summary: Opportunities.batch_delete operationId: LeadOpportunity_removeBatchOpportunities description: Removes Opportunities with given list of ids parameters: - description: >- Specify validation level of Opportunities 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpportunitiesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpportunitiesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hrrd5kvm667yx /entities/Opportunities/batch-modify: post: tags: - Lead & Opportunity summary: Opportunities.batch_create_or_update operationId: LeadOpportunity_modifyBatch description: Create or update an batch of Opportunities parameters: - description: >- Specify validation level of Opportunities 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Opportunity required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityModifyBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated Opportunities content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityModifyBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ewfrzqnchucw6 /entities/OpportunityTypes/{id}: get: tags: - Lead & Opportunity summary: OpportunityTypes.get operationId: LeadOpportunity_getById description: Returns OpportunityType with given id parameters: - description: ID of OpportunityType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpportunityType data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n8y8cggynzfuw delete: tags: - Lead & Opportunity summary: OpportunityTypes.delete operationId: LeadOpportunity_removeById description: Removes OpportunityType with given id parameters: - description: ID of OpportunityType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpportunityType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zf0cdxl71tsui patch: tags: - Lead & Opportunity summary: OpportunityTypes.update operationId: LeadOpportunity_modifyOpportunityType description: Modifies OpportunityType or OpportunityTypes with given id(s) parameters: - description: ID of OpportunityType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpportunityType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpportunityTypeInput' responses: '200': description: Modification confirmation. Returns resulting OpportunityType content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyOpportunityTypeResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pefl0pfau785l /entities/OpportunityTypes: get: tags: - Lead & Opportunity summary: OpportunityTypes.list operationId: LeadOpportunity_getAllOpportunityTypes description: Returns all defined OpportunityTypes parameters: - description: if enabled, deleted OpportunityTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpportunityTypes content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpportunityTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aremt906l8y1l post: tags: - Lead & Opportunity summary: OpportunityTypes.create operationId: LeadOpportunity_createNewOpportunityType description: Creates new OpportunityType parameters: - description: >- Specify validation level of OpportunityType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpportunityType required: true content: application / json: schema: $ref: '#/components/schemas/createOpportunityTypeInput' responses: '201': description: Creation confirmation. Returns created OpportunityType content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpportunityTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p7fjdzswedau2 /entities/OpportunityTypes/batch-delete: post: tags: - Lead & Opportunity summary: OpportunityTypes.batch_delete operationId: LeadOpportunity_removeBatchOpportunityTypes description: Removes OpportunityTypes with given list of ids parameters: - description: >- Specify validation level of OpportunityTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpportunityTypesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpportunityTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4bsnk9x2zxuhe /entities/OpportunityTypes/batch-modify: post: tags: - Lead & Opportunity summary: OpportunityTypes.batch_create_or_update operationId: LeadOpportunity_batchModifyOpportunityTypes description: Create or update an batch of OpportunityTypes parameters: - description: >- Specify validation level of OpportunityTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpportunityType required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpportunityTypesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpportunityTypes content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpportunityTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ryw17u6r5cwvf /entities/OpptyProductRelations/{id}: get: tags: - Product Line Items summary: OpptyProductRelations.get operationId: ProductLineItems_getById description: Returns OpptyProductRelation with given id parameters: - description: ID of OpptyProductRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelation data content: application/json: schema: $ref: '#/components/schemas/ProductLineItemsGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7k9hsc39by3ib delete: tags: - Product Line Items summary: OpptyProductRelations.delete operationId: ProductLineItems_removeById description: Removes OpptyProductRelation with given id parameters: - description: ID of OpptyProductRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductLineItemsRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z0nudwml2rmka patch: tags: - Product Line Items summary: OpptyProductRelations.update operationId: ProductLineItems_modifyOpptyProductRelation description: Modifies OpptyProductRelation or OpptyProductRelations with given id(s) parameters: - description: ID of OpptyProductRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationInput' responses: '200': description: Modification confirmation. Returns resulting OpptyProductRelation content: application/json: schema: $ref: >- #/components/schemas/ProductLineItemsModifyOpptyProductRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g0177mdosgt9c /entities/OpptyProductRelations: get: tags: - Product Line Items summary: OpptyProductRelations.list operationId: ProductLineItems_getAllOpptyProductRelations description: Returns all defined OpptyProductRelations parameters: - description: if enabled, deleted OpptyProductRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelations content: application/json: schema: $ref: >- #/components/schemas/ProductLineItemsGetAllOpptyProductRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6c5kj4gedxe22 post: tags: - Product Line Items summary: OpptyProductRelations.create operationId: ProductLineItems_createNew description: Creates new OpptyProductRelation parameters: - description: >- Specify validation level of OpptyProductRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelation required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelation content: application/json: schema: $ref: '#/components/schemas/ProductLineItemsCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: glmxu0zauj3b0 /entities/OpptyProductRelations/batch-delete: post: tags: - Product Line Items summary: OpptyProductRelations.batch_delete operationId: ProductLineItems_removeBatchOpptyProductRelations description: Removes OpptyProductRelations with given list of ids parameters: - description: >- Specify validation level of OpptyProductRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/ProductLineItemsRemoveBatchOpptyProductRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ProductLineItemsRemoveBatchOpptyProductRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9gkj1sy6cmwgv /entities/OpptyProductRelations/batch-modify: post: tags: - Product Line Items summary: OpptyProductRelations.batch_create_or_update operationId: ProductLineItems_batchCreateOrUpdate description: Create or update an batch of OpptyProductRelations parameters: - description: >- Specify validation level of OpptyProductRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelation required: true content: application / json: schema: $ref: '#/components/schemas/ProductLineItemsBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyProductRelations content: application/json: schema: $ref: >- #/components/schemas/ProductLineItemsBatchCreateOrUpdateResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pvrcyfqzszmt7 /entities/OpptyProductRelationDataExRelations/{id}: get: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.get operationId: LeadOpportunity_getProductRelationDataExRelationById description: Returns OpptyProductRelationDataExRelation with given id parameters: - description: ID of OpptyProductRelationDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationDataExRelation data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetProductRelationDataExRelationByIdResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9pv68ldi4bwz3 delete: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.delete operationId: LeadOpportunity_removeById description: Removes OpptyProductRelationDataExRelation with given id parameters: - description: ID of OpptyProductRelationDataExRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lgajgpryw7jp7 patch: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.update operationId: LeadOpportunity_updateRelationDataEx description: >- Modifies OpptyProductRelationDataExRelation or OpptyProductRelationDataExRelations with given id(s) parameters: - description: ID of OpptyProductRelationDataExRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateOpptyProductRelationDataExRelationInput responses: '200': description: >- Modification confirmation. Returns resulting OpptyProductRelationDataExRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityUpdateRelationDataExResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0djs9fpxhv8ix /entities/OpptyProductRelationDataExRelations: get: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.list operationId: LeadOpportunity_getAllOpptyProductRelationDataExRelations description: Returns all defined OpptyProductRelationDataExRelations parameters: - description: >- if enabled, deleted OpptyProductRelationDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationDataExRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpptyProductRelationDataExRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uqqgfey19nxl7 post: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.create operationId: LeadOpportunity_createOpptyProductRelationDataExRelation description: Creates new OpptyProductRelationDataExRelation parameters: - description: >- Specify validation level of OpptyProductRelationDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationDataExRelation required: true content: application / json: schema: $ref: >- #/components/schemas/createOpptyProductRelationDataExRelationInput responses: '201': description: >- Creation confirmation. Returns created OpptyProductRelationDataExRelation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateOpptyProductRelationDataExRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8kcvgc58u6ibi /entities/OpptyProductRelationDataExRelations/batch-delete: post: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.batch_delete operationId: LeadOpportunity_removeRelationsByIds description: Removes OpptyProductRelationDataExRelations with given list of ids parameters: - description: >- Specify validation level of OpptyProductRelationDataExRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveRelationsByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveRelationsByIdsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ywndnrfp7sqe4 /entities/OpptyProductRelationDataExRelations/batch-modify: post: tags: - Lead & Opportunity summary: OpptyProductRelationDataExRelations.batch_create_or_update operationId: LeadOpportunity_batchCreateOrUpdate description: Create or update an batch of OpptyProductRelationDataExRelations parameters: - description: >- Specify validation level of OpptyProductRelationDataExRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyProductRelationDataExRelations content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchCreateOrUpdateResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d01biglfoq5sg /entities/OpptyProductRelationRevenueSchedules/{id}: get: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.get operationId: LeadOpportunity_getOpptyProductRelationRevenueSchedule description: Returns OpptyProductRelationRevenueSchedule with given id parameters: - description: ID of OpptyProductRelationRevenueSchedule to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationRevenueSchedule data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetOpptyProductRelationRevenueScheduleResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l5dd1xbmlxfgx delete: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.delete operationId: LeadOpportunity_removeById description: Removes OpptyProductRelationRevenueSchedule with given id parameters: - description: ID of OpptyProductRelationRevenueSchedule to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9rbqm1chvk9ia patch: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.update operationId: LeadOpportunity_updateRevenueSchedule description: >- Modifies OpptyProductRelationRevenueSchedule or OpptyProductRelationRevenueSchedules with given id(s) parameters: - description: ID of OpptyProductRelationRevenueSchedule to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateOpptyProductRelationRevenueScheduleInput responses: '200': description: >- Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedule content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityUpdateRevenueScheduleResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8k0sgkilzf412 /entities/OpptyProductRelationRevenueSchedules: get: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.list operationId: LeadOpportunity_getAllOpptyProductRelationRevenueSchedules description: Returns all defined OpptyProductRelationRevenueSchedules parameters: - description: >- if enabled, deleted OpptyProductRelationRevenueSchedules are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationRevenueSchedules content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpptyProductRelationRevenueSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x7aa42or0gwho post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.create operationId: LeadOpportunity_createNewOpptyProductRelationRevenueSchedule description: Creates new OpptyProductRelationRevenueSchedule parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedule required: true content: application / json: schema: $ref: >- #/components/schemas/createOpptyProductRelationRevenueScheduleInput responses: '201': description: >- Creation confirmation. Returns created OpptyProductRelationRevenueSchedule content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpptyProductRelationRevenueScheduleResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1rxjk22hmsx2k /entities/OpptyProductRelationRevenueSchedules/batch-delete: post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.batch_delete operationId: LeadOpportunity_removeBatchOpptyProductRelationRevenueSchedules description: Removes OpptyProductRelationRevenueSchedules with given list of ids parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z3nobhk3l54pl /entities/OpptyProductRelationRevenueSchedules/batch-modify: post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedules.batch_create_or_update operationId: LeadOpportunity_batchModifyOpptyProductRelationRevenueSchedules description: Create or update an batch of OpptyProductRelationRevenueSchedules parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedule required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedules content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xd824jcpctagq /entities/OpptyProductRelationRevenueSchedulePeriods/{id}: get: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.get operationId: LeadOpportunity_getRevenueSchedulePeriodById description: Returns OpptyProductRelationRevenueSchedulePeriod with given id parameters: - description: ID of OpptyProductRelationRevenueSchedulePeriod to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationRevenueSchedulePeriod data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetRevenueSchedulePeriodByIdResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q945xe4nfyuz8 delete: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.delete operationId: LeadOpportunity_removeById description: Removes OpptyProductRelationRevenueSchedulePeriod with given id parameters: - description: ID of OpptyProductRelationRevenueSchedulePeriod to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response11' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: etwiynte6kwj8 patch: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.update operationId: LeadOpportunity_updatePeriod description: >- Modifies OpptyProductRelationRevenueSchedulePeriod or OpptyProductRelationRevenueSchedulePeriods with given id(s) parameters: - description: ID of OpptyProductRelationRevenueSchedulePeriod to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: >- #/components/schemas/updateOpptyProductRelationRevenueSchedulePeriodInput responses: '200': description: >- Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedulePeriod content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityUpdatePeriodResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fp5mj882yudx8 /entities/OpptyProductRelationRevenueSchedulePeriods: get: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.list operationId: LeadOpportunity_listOpptyProductRelationRevenueSchedulePeriods description: Returns all defined OpptyProductRelationRevenueSchedulePeriods parameters: - description: >- if enabled, deleted OpptyProductRelationRevenueSchedulePeriods are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationRevenueSchedulePeriods content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityListOpptyProductRelationRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lq5o5g9aq072q post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.create operationId: LeadOpportunity_createNewOpptyProductRelationRevenueSchedulePeriod description: Creates new OpptyProductRelationRevenueSchedulePeriod parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedulePeriod required: true content: application / json: schema: $ref: >- #/components/schemas/createOpptyProductRelationRevenueSchedulePeriodInput responses: '201': description: >- Creation confirmation. Returns created OpptyProductRelationRevenueSchedulePeriod content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpptyProductRelationRevenueSchedulePeriodResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kqocpazr8xmlr /entities/OpptyProductRelationRevenueSchedulePeriods/batch-delete: post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.batch_delete operationId: LeadOpportunity_removeBatchOpptyProductRelationRevenueSchedulePeriods description: >- Removes OpptyProductRelationRevenueSchedulePeriods with given list of ids parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedulePeriods 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulePeriodsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lr5nvq3uz6mo1 /entities/OpptyProductRelationRevenueSchedulePeriods/batch-modify: post: tags: - Lead & Opportunity summary: OpptyProductRelationRevenueSchedulePeriods.batch_create_or_update operationId: LeadOpportunity_batchModifyOpptyProductRelationRevenueSchedulePeriods description: Create or update an batch of OpptyProductRelationRevenueSchedulePeriods parameters: - description: >- Specify validation level of OpptyProductRelationRevenueSchedulePeriods 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedulePeriod required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulePeriodsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedulePeriods content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zhesb6dwoondq /entities/OpptyProductRelationTypes/{id}: get: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.get operationId: LeadOpportunity_getOpptyProductRelationType description: Returns OpptyProductRelationType with given id parameters: - description: ID of OpptyProductRelationType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationType data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetOpptyProductRelationTypeResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: clonv4is94c79 delete: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.delete operationId: LeadOpportunity_removeById description: Removes OpptyProductRelationType with given id parameters: - description: ID of OpptyProductRelationType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response12' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r0il6fyj4z64k patch: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.update operationId: LeadOpportunity_modifyOpptyProductRelationType description: >- Modifies OpptyProductRelationType or OpptyProductRelationTypes with given id(s) parameters: - description: ID of OpptyProductRelationType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyProductRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationTypeInput' responses: '200': description: >- Modification confirmation. Returns resulting OpptyProductRelationType content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyOpptyProductRelationTypeResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qwq7odty31w8b /entities/OpptyProductRelationTypes: get: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.list operationId: LeadOpportunity_getList description: Returns all defined OpptyProductRelationTypes parameters: - description: if enabled, deleted OpptyProductRelationTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationTypes content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetList200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0hqapu9tyo29m post: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.create operationId: LeadOpportunity_createNewOpptyProductRelationType description: Creates new OpptyProductRelationType parameters: - description: >- Specify validation level of OpptyProductRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationTypeInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelationType content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpptyProductRelationTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vpphh447bksgx /entities/OpptyProductRelationTypes/batch-delete: post: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.batch_delete operationId: LeadOpportunity_removeByIds description: Removes OpptyProductRelationTypes with given list of ids parameters: - description: >- Specify validation level of OpptyProductRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdsRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIds200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jq5uxl6ui7gp7 /entities/OpptyProductRelationTypes/batch-modify: post: tags: - Lead & Opportunity summary: OpptyProductRelationTypes.batch_create_or_update operationId: LeadOpportunity_modifyOpptyProductRelationTypesBatch description: Create or update an batch of OpptyProductRelationTypes parameters: - description: >- Specify validation level of OpptyProductRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationType required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyOpptyProductRelationTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyProductRelationTypes content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyOpptyProductRelationTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u9jvacbnpqu49 /entities/OpptyRecurrences/{id}: get: tags: - Lead & Opportunity summary: OpptyRecurrences.get operationId: LeadOpportunity_getOpptyRecurrence description: Returns OpptyRecurrence with given id parameters: - description: ID of OpptyRecurrence to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyRecurrence data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetOpptyRecurrenceResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ic7xtla87d4fb delete: tags: - Lead & Opportunity summary: OpptyRecurrences.delete operationId: LeadOpportunity_removeOpptyRecurrence description: Removes OpptyRecurrence with given id parameters: - description: ID of OpptyRecurrence to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRecurrence 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveOpptyRecurrenceResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ebkgqnmk1eueg patch: tags: - Lead & Opportunity summary: OpptyRecurrences.update operationId: LeadOpportunity_updateOpptyRecurrence description: Modifies OpptyRecurrence or OpptyRecurrences with given id(s) parameters: - description: ID of OpptyRecurrence to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRecurrence 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRecurrenceInput' responses: '200': description: Modification confirmation. Returns resulting OpptyRecurrence content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityUpdateOpptyRecurrenceResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b58zsclbmq6vl /entities/OpptyRecurrences: get: tags: - Lead & Opportunity summary: OpptyRecurrences.list operationId: LeadOpportunity_getAllOpptyRecurrences description: Returns all defined OpptyRecurrences parameters: - description: if enabled, deleted OpptyRecurrences are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRecurrences content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpptyRecurrencesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hceqjwla7q886 post: tags: - Lead & Opportunity summary: OpptyRecurrences.create operationId: LeadOpportunity_createOpptyRecurrence description: Creates new OpptyRecurrence parameters: - description: >- Specify validation level of OpptyRecurrence 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRecurrence required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRecurrenceInput' responses: '201': description: Creation confirmation. Returns created OpptyRecurrence content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateOpptyRecurrenceResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fa2s5qurdlinn /entities/OpptyRecurrences/batch-delete: post: tags: - Lead & Opportunity summary: OpptyRecurrences.batch_delete operationId: LeadOpportunity_removeByIds description: Removes OpptyRecurrences with given list of ids parameters: - description: >- Specify validation level of OpptyRecurrences 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIdsRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveByIds200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: biqdojrmqbkye /entities/OpptyRecurrences/batch-modify: post: tags: - Lead & Opportunity summary: OpptyRecurrences.batch_create_or_update operationId: LeadOpportunity_batchModifyOpptyRecurrences description: Create or update an batch of OpptyRecurrences parameters: - description: >- Specify validation level of OpptyRecurrences 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRecurrence required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyRecurrencesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyRecurrences content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyRecurrencesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ce11qff4haaph /entities/OpptyRevenueSchedules/{id}: get: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.get operationId: LeadOpportunity_getById description: Returns OpptyRevenueSchedule with given id parameters: - description: ID of OpptyRevenueSchedule to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyRevenueSchedule data content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityGetById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: md6v2t7qksneh delete: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.delete operationId: LeadOpportunity_removeOpptyRevenueSchedule description: Removes OpptyRevenueSchedule with given id parameters: - description: ID of OpptyRevenueSchedule to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveOpptyRevenueScheduleResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 06atvevvnn1q9 patch: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.update operationId: LeadOpportunity_modifyOpptyRevenueSchedule description: Modifies OpptyRevenueSchedule or OpptyRevenueSchedules with given id(s) parameters: - description: ID of OpptyRevenueSchedule to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRevenueScheduleInput' responses: '200': description: Modification confirmation. Returns resulting OpptyRevenueSchedule content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyOpptyRevenueScheduleResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b3wml3o77pw8o /entities/OpptyRevenueSchedules: get: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.list operationId: LeadOpportunity_getAllOpptyRevenueSchedules description: Returns all defined OpptyRevenueSchedules parameters: - description: if enabled, deleted OpptyRevenueSchedules are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRevenueSchedules content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpptyRevenueSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c5f49w9kmiyva post: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.create operationId: LeadOpportunity_createOpptyRevenueSchedule description: Creates new OpptyRevenueSchedule parameters: - description: >- Specify validation level of OpptyRevenueSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedule required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRevenueScheduleInput' responses: '201': description: Creation confirmation. Returns created OpptyRevenueSchedule content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateOpptyRevenueScheduleResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zpfcqshonm9ka /entities/OpptyRevenueSchedules/batch-delete: post: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.batch_delete operationId: LeadOpportunity_removeBatch description: Removes OpptyRevenueSchedules with given list of ids parameters: - description: >- Specify validation level of OpptyRevenueSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatchRequest7' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveBatch200Response6' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dgd5k2g6jp3gl /entities/OpptyRevenueSchedules/batch-modify: post: tags: - Lead & Opportunity summary: OpptyRevenueSchedules.batch_create_or_update operationId: LeadOpportunity_modifyBatchOpptyRevenueSchedules description: Create or update an batch of OpptyRevenueSchedules parameters: - description: >- Specify validation level of OpptyRevenueSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedule required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchOpptyRevenueSchedulesRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyRevenueSchedules content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityModifyBatchOpptyRevenueSchedulesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nlvd45wfe3s0v /entities/OpptyRevenueSchedulePeriods/{id}: get: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.get operationId: LeadOpportunity_getOpptyRevenueSchedulePeriod description: Returns OpptyRevenueSchedulePeriod with given id parameters: - description: ID of OpptyRevenueSchedulePeriod to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: OpptyRevenueSchedulePeriod data content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetOpptyRevenueSchedulePeriodResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cur15quru1xxf delete: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.delete operationId: LeadOpportunity_removeById description: Removes OpptyRevenueSchedulePeriod with given id parameters: - description: ID of OpptyRevenueSchedulePeriod to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/LeadOpportunityRemoveById200Response13' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 11adkz3x8n6vc patch: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.update operationId: LeadOpportunity_updateOpptyRevenueSchedulePeriod description: >- Modifies OpptyRevenueSchedulePeriod or OpptyRevenueSchedulePeriods with given id(s) parameters: - description: ID of OpptyRevenueSchedulePeriod to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of OpptyRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRevenueSchedulePeriodInput' responses: '200': description: >- Modification confirmation. Returns resulting OpptyRevenueSchedulePeriod content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityUpdateOpptyRevenueSchedulePeriodResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2xjnm4a3s1srt /entities/OpptyRevenueSchedulePeriods: get: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.list operationId: LeadOpportunity_getAllOpptyRevenueSchedulePeriods description: Returns all defined OpptyRevenueSchedulePeriods parameters: - description: if enabled, deleted OpptyRevenueSchedulePeriods are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRevenueSchedulePeriods content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityGetAllOpptyRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ygj06ngiz2gv7 post: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.create operationId: LeadOpportunity_createNewOpptyRevenueSchedulePeriod description: Creates new OpptyRevenueSchedulePeriod parameters: - description: >- Specify validation level of OpptyRevenueSchedulePeriod 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedulePeriod required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRevenueSchedulePeriodInput' responses: '201': description: Creation confirmation. Returns created OpptyRevenueSchedulePeriod content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityCreateNewOpptyRevenueSchedulePeriodResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1bjczuawhy4io /entities/OpptyRevenueSchedulePeriods/batch-delete: post: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.batch_delete operationId: LeadOpportunity_removeBatchOpptyRevenueSchedulePeriods description: Removes OpptyRevenueSchedulePeriods with given list of ids parameters: - description: >- Specify validation level of OpptyRevenueSchedulePeriods 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyRevenueSchedulePeriodsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityRemoveBatchOpptyRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: riaffto101kln /entities/OpptyRevenueSchedulePeriods/batch-modify: post: tags: - Lead & Opportunity summary: OpptyRevenueSchedulePeriods.batch_create_or_update operationId: LeadOpportunity_batchModifyOpptyRevenueSchedulePeriods description: Create or update an batch of OpptyRevenueSchedulePeriods parameters: - description: >- Specify validation level of OpptyRevenueSchedulePeriods 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedulePeriod required: true content: application / json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyRevenueSchedulePeriodsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated OpptyRevenueSchedulePeriods content: application/json: schema: $ref: >- #/components/schemas/LeadOpportunityBatchModifyOpptyRevenueSchedulePeriodsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ey4uqoaw7q5ek /entities/ParentAccountRelationTypes/{id}: get: tags: - Account summary: ParentAccountRelationTypes.get operationId: Account_getById description: Returns ParentAccountRelationType with given id parameters: - description: ID of ParentAccountRelationType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ParentAccountRelationType data content: application/json: schema: $ref: '#/components/schemas/AccountGetById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e7f98rx6qysep delete: tags: - Account summary: ParentAccountRelationTypes.delete operationId: Account_removeById description: Removes ParentAccountRelationType with given id parameters: - description: ID of ParentAccountRelationType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ParentAccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/AccountRemoveById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9d7ic3vle9nou patch: tags: - Account summary: ParentAccountRelationTypes.update operationId: Account_updateRelationType description: >- Modifies ParentAccountRelationType or ParentAccountRelationTypes with given id(s) parameters: - description: ID of ParentAccountRelationType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ParentAccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateParentAccountRelationTypeInput' responses: '200': description: >- Modification confirmation. Returns resulting ParentAccountRelationType content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRelationTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bju4x70563m44 /entities/ParentAccountRelationTypes: get: tags: - Account summary: ParentAccountRelationTypes.list operationId: Account_listParentAccountRelationTypes description: Returns all defined ParentAccountRelationTypes parameters: - description: if enabled, deleted ParentAccountRelationTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ParentAccountRelationTypes content: application/json: schema: $ref: >- #/components/schemas/AccountListParentAccountRelationTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ed6t6ylc2fri1 post: tags: - Account summary: ParentAccountRelationTypes.create operationId: Account_createNewParentAccountRelationType description: Creates new ParentAccountRelationType parameters: - description: >- Specify validation level of ParentAccountRelationType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ParentAccountRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createParentAccountRelationTypeInput' responses: '201': description: Creation confirmation. Returns created ParentAccountRelationType content: application/json: schema: $ref: >- #/components/schemas/AccountCreateNewParentAccountRelationTypeResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ywsucoogus5qu /entities/ParentAccountRelationTypes/batch-delete: post: tags: - Account summary: ParentAccountRelationTypes.batch_delete operationId: Account_removeParentAccountRelationTypes description: Removes ParentAccountRelationTypes with given list of ids parameters: - description: >- Specify validation level of ParentAccountRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/AccountRemoveParentAccountRelationTypesRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/AccountRemoveParentAccountRelationTypesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ytqjvuvd19s7v /entities/ParentAccountRelationTypes/batch-modify: post: tags: - Account summary: ParentAccountRelationTypes.batch_create_or_update operationId: Account_modifyParentAccountRelationTypesBatch description: Create or update an batch of ParentAccountRelationTypes parameters: - description: >- Specify validation level of ParentAccountRelationTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ParentAccountRelationType required: true content: application / json: schema: $ref: >- #/components/schemas/AccountModifyParentAccountRelationTypesBatchRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ParentAccountRelationTypes content: application/json: schema: $ref: >- #/components/schemas/AccountModifyParentAccountRelationTypesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2n2nraxs550rr /entities/Phones/{id}: get: tags: - Phone summary: Phones.get operationId: Phone_getById description: Returns Phone with given id parameters: - description: ID of Phone to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Phone data content: application/json: schema: $ref: '#/components/schemas/PhoneGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wux1kjoh19faq delete: tags: - Phone summary: Phones.delete operationId: Phone_removeById description: Removes Phone with given id parameters: - description: ID of Phone to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Phone 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/PhoneRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qfyfk0ml4vjub patch: tags: - Phone summary: Phones.update operationId: Phone_modifyById description: Modifies Phone or Phones with given id(s) parameters: - description: ID of Phone to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Phone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updatePhoneInput' responses: '200': description: Modification confirmation. Returns resulting Phone content: application/json: schema: $ref: '#/components/schemas/PhoneModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0ynfifd1fqomb /entities/Phones: get: tags: - Phone summary: Phones.list operationId: Phone_getAllPhones description: Returns all defined Phones parameters: - description: if enabled, deleted Phones are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Phones content: application/json: schema: $ref: '#/components/schemas/PhoneGetAllPhonesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: myfn6glsjoylo post: tags: - Phone summary: Phones.create operationId: Phone_registerNewPhone description: Creates new Phone parameters: - description: >- Specify validation level of Phone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Phone required: true content: application / json: schema: $ref: '#/components/schemas/createPhoneInput' responses: '201': description: Creation confirmation. Returns created Phone content: application/json: schema: $ref: '#/components/schemas/PhoneRegisterNewPhoneResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bml8lalwx54vk /entities/Phones/batch-delete: post: tags: - Phone summary: Phones.batch_delete operationId: Phone_removeBatch description: Removes Phones with given list of ids parameters: - description: >- Specify validation level of Phones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Phones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/PhoneRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/PhoneRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m0tfuurj62qif /entities/Phones/batch-modify: post: tags: - Phone summary: Phones.batch_create_or_update operationId: Phone_batchModifyPhones description: Create or update an batch of Phones parameters: - description: >- Specify validation level of Phones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Phones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Phone required: true content: application / json: schema: $ref: '#/components/schemas/PhoneBatchModifyPhonesRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Phones content: application/json: schema: $ref: '#/components/schemas/PhoneBatchModifyPhonesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dpgifg4sv5lnw /entities/Pipelines/{id}: get: tags: - Pipeline summary: Pipelines.get operationId: Pipeline_getById description: Returns Pipeline with given id parameters: - description: ID of Pipeline to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Pipeline data content: application/json: schema: $ref: '#/components/schemas/PipelineGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3djaf27i7afnl delete: tags: - Pipeline summary: Pipelines.delete operationId: Pipeline_removeById description: Removes Pipeline with given id parameters: - description: ID of Pipeline to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Pipeline 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/PipelineRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 83pqw3axkmngf patch: tags: - Pipeline summary: Pipelines.update operationId: Pipeline_modifyById description: Modifies Pipeline or Pipelines with given id(s) parameters: - description: ID of Pipeline to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Pipeline 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updatePipelineInput' responses: '200': description: Modification confirmation. Returns resulting Pipeline content: application/json: schema: $ref: '#/components/schemas/PipelineModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qke4v3bs5czgu /entities/Pipelines: get: tags: - Pipeline summary: Pipelines.list operationId: Pipeline_getAll description: Returns all defined Pipelines parameters: - description: if enabled, deleted Pipelines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Pipelines content: application/json: schema: $ref: '#/components/schemas/PipelineGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7oykovxg5ixjl post: tags: - Pipeline summary: Pipelines.create operationId: Pipeline_registerNewPipeline description: Creates new Pipeline parameters: - description: >- Specify validation level of Pipeline 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Pipeline required: true content: application / json: schema: $ref: '#/components/schemas/createPipelineInput' responses: '201': description: Creation confirmation. Returns created Pipeline content: application/json: schema: $ref: '#/components/schemas/PipelineRegisterNewPipelineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4tcnp0hvh8mrz /entities/Pipelines/batch-delete: post: tags: - Pipeline summary: Pipelines.batch_delete operationId: Pipeline_removeBatch description: Removes Pipelines with given list of ids parameters: - description: >- Specify validation level of Pipelines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Pipelines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/PipelineRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/PipelineRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ln8iapal5fn9k /entities/Pipelines/batch-modify: post: tags: - Pipeline summary: Pipelines.batch_create_or_update operationId: Pipeline_batchModify description: Create or update an batch of Pipelines parameters: - description: >- Specify validation level of Pipelines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Pipelines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Pipeline required: true content: application / json: schema: $ref: '#/components/schemas/PipelineBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Pipelines content: application/json: schema: $ref: '#/components/schemas/PipelineBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ksm49atnblogb /entities/Processes/{id}: get: tags: - Process summary: Processes.get operationId: Process_getById description: Returns Process with given id parameters: - description: ID of Process to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Process data content: application/json: schema: $ref: '#/components/schemas/ProcessGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lirfvodp2duxq delete: tags: - Process summary: Processes.delete operationId: Process_removeById description: Removes Process with given id parameters: - description: ID of Process to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Process 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e49kzkt982l3z patch: tags: - Process summary: Processes.update operationId: Process_modifyById description: Modifies Process or Processes with given id(s) parameters: - description: ID of Process to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Process 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProcessInput' responses: '200': description: Modification confirmation. Returns resulting Process content: application/json: schema: $ref: '#/components/schemas/ProcessModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: osnidxvhvl4gk /entities/Processes: get: tags: - Process summary: Processes.list operationId: Process_getAllDefined description: Returns all defined Processes parameters: - description: if enabled, deleted Processes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Processes content: application/json: schema: $ref: '#/components/schemas/ProcessGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lguik12xnkn4g post: tags: - Process summary: Processes.create operationId: Process_registerNewProcess description: Creates new Process parameters: - description: >- Specify validation level of Process 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Process required: true content: application / json: schema: $ref: '#/components/schemas/createProcessInput' responses: '201': description: Creation confirmation. Returns created Process content: application/json: schema: $ref: '#/components/schemas/ProcessRegisterNewProcessResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: adqc1gtt6o01z /entities/Processes/batch-delete: post: tags: - Process summary: Processes.batch_delete operationId: Process_removeBatch description: Removes Processes with given list of ids parameters: - description: >- Specify validation level of Processes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Processes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProcessRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hu8kcfxs4csql /entities/Processes/batch-modify: post: tags: - Process summary: Processes.batch_create_or_update operationId: Process_batchModifyEntities description: Create or update an batch of Processes parameters: - description: >- Specify validation level of Processes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Processes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Process required: true content: application / json: schema: $ref: '#/components/schemas/ProcessBatchModifyEntitiesRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Processes content: application/json: schema: $ref: '#/components/schemas/ProcessBatchModifyEntitiesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mofz2ytpczem0 /entities/ProcessActivityLogs/{id}: get: tags: - Process summary: ProcessActivityLogs.get operationId: Process_getById description: Returns ProcessActivityLog with given id parameters: - description: ID of ProcessActivityLog to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProcessActivityLog data content: application/json: schema: $ref: '#/components/schemas/ProcessGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qmmprhoscdzvm delete: tags: - Process summary: ProcessActivityLogs.delete operationId: Process_removeById description: Removes ProcessActivityLog with given id parameters: - description: ID of ProcessActivityLog to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessActivityLog 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1o9bwt2ak1g1q patch: tags: - Process summary: ProcessActivityLogs.update operationId: Process_modifyActivityLog description: Modifies ProcessActivityLog or ProcessActivityLogs with given id(s) parameters: - description: ID of ProcessActivityLog to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessActivityLog 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProcessActivityLogInput' responses: '200': description: Modification confirmation. Returns resulting ProcessActivityLog content: application/json: schema: $ref: '#/components/schemas/ProcessModifyActivityLogResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 543lxzajyboxm /entities/ProcessActivityLogs: get: tags: - Process summary: ProcessActivityLogs.list operationId: Process_getAllLogs description: Returns all defined ProcessActivityLogs parameters: - description: if enabled, deleted ProcessActivityLogs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProcessActivityLogs content: application/json: schema: $ref: '#/components/schemas/ProcessGetAllLogsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qufwoiz2g2pcj post: tags: - Process summary: ProcessActivityLogs.create operationId: Process_createActivityLog description: Creates new ProcessActivityLog parameters: - description: >- Specify validation level of ProcessActivityLog 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProcessActivityLog required: true content: application / json: schema: $ref: '#/components/schemas/createProcessActivityLogInput' responses: '201': description: Creation confirmation. Returns created ProcessActivityLog content: application/json: schema: $ref: '#/components/schemas/ProcessCreateActivityLogResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5qejv7rffap7f /entities/ProcessActivityLogs/batch-delete: post: tags: - Process summary: ProcessActivityLogs.batch_delete operationId: Process_removeByIds description: Removes ProcessActivityLogs with given list of ids parameters: - description: >- Specify validation level of ProcessActivityLogs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessActivityLogs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProcessRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3v3llt2uuyfwo /entities/ProcessActivityLogs/batch-modify: post: tags: - Process summary: ProcessActivityLogs.batch_create_or_update operationId: Process_modifyBatchActivityLogs description: Create or update an batch of ProcessActivityLogs parameters: - description: >- Specify validation level of ProcessActivityLogs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessActivityLogs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProcessActivityLog required: true content: application / json: schema: $ref: '#/components/schemas/ProcessModifyBatchActivityLogsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProcessActivityLogs content: application/json: schema: $ref: '#/components/schemas/ProcessModifyBatchActivityLogsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z1ig8lw0iv3i3 /entities/ProcessActivityLogLines/{id}: get: tags: - Process summary: ProcessActivityLogLines.get operationId: Process_getById description: Returns ProcessActivityLogLine with given id parameters: - description: ID of ProcessActivityLogLine to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProcessActivityLogLine data content: application/json: schema: $ref: '#/components/schemas/ProcessGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2d98qekb15nas delete: tags: - Process summary: ProcessActivityLogLines.delete operationId: Process_removeById description: Removes ProcessActivityLogLine with given id parameters: - description: ID of ProcessActivityLogLine to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tu7lgj842xdoy patch: tags: - Process summary: ProcessActivityLogLines.update operationId: Process_modifyLogLines description: >- Modifies ProcessActivityLogLine or ProcessActivityLogLines with given id(s) parameters: - description: ID of ProcessActivityLogLine to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProcessActivityLogLineInput' responses: '200': description: Modification confirmation. Returns resulting ProcessActivityLogLine content: application/json: schema: $ref: '#/components/schemas/ProcessModifyLogLinesResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i19nvushjkqb7 /entities/ProcessActivityLogLines: get: tags: - Process summary: ProcessActivityLogLines.list operationId: Process_getAll description: Returns all defined ProcessActivityLogLines parameters: - description: if enabled, deleted ProcessActivityLogLines are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProcessActivityLogLines content: application/json: schema: $ref: '#/components/schemas/ProcessGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x80vr82juk4w9 post: tags: - Process summary: ProcessActivityLogLines.create operationId: Process_createLogLine description: Creates new ProcessActivityLogLine parameters: - description: >- Specify validation level of ProcessActivityLogLine 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProcessActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/createProcessActivityLogLineInput' responses: '201': description: Creation confirmation. Returns created ProcessActivityLogLine content: application/json: schema: $ref: '#/components/schemas/ProcessCreateLogLineResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d11dbp8m9d9s5 /entities/ProcessActivityLogLines/batch-delete: post: tags: - Process summary: ProcessActivityLogLines.batch_delete operationId: Process_removeByIds description: Removes ProcessActivityLogLines with given list of ids parameters: - description: >- Specify validation level of ProcessActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProcessRemoveByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lv8x6f17irz5l /entities/ProcessActivityLogLines/batch-modify: post: tags: - Process summary: ProcessActivityLogLines.batch_create_or_update operationId: Process_createOrUpdateBatchLogLines description: Create or update an batch of ProcessActivityLogLines parameters: - description: >- Specify validation level of ProcessActivityLogLines 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProcessActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/ProcessCreateOrUpdateBatchLogLinesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProcessActivityLogLines content: application/json: schema: $ref: >- #/components/schemas/ProcessCreateOrUpdateBatchLogLinesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4xx5ytagp7vxy /entities/ProcessTemplates/{id}: get: tags: - Process summary: ProcessTemplates.get operationId: Process_getById description: Returns ProcessTemplate with given id parameters: - description: ID of ProcessTemplate to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProcessTemplate data content: application/json: schema: $ref: '#/components/schemas/ProcessGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eds85kr06vx2v delete: tags: - Process summary: ProcessTemplates.delete operationId: Process_removeById description: Removes ProcessTemplate with given id parameters: - description: ID of ProcessTemplate to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessTemplate 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qpk1pxav5156n patch: tags: - Process summary: ProcessTemplates.update operationId: Process_modifyTemplateById description: Modifies ProcessTemplate or ProcessTemplates with given id(s) parameters: - description: ID of ProcessTemplate to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProcessTemplate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProcessTemplateInput' responses: '200': description: Modification confirmation. Returns resulting ProcessTemplate content: application/json: schema: $ref: '#/components/schemas/ProcessModifyTemplateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ufwy37d2ev00s /entities/ProcessTemplates: get: tags: - Process summary: ProcessTemplates.list operationId: Process_getAllTemplates description: Returns all defined ProcessTemplates parameters: - description: if enabled, deleted ProcessTemplates are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProcessTemplates content: application/json: schema: $ref: '#/components/schemas/ProcessGetAllTemplatesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ckqoohg864085 post: tags: - Process summary: ProcessTemplates.create operationId: Process_createNewProcessTemplate description: Creates new ProcessTemplate parameters: - description: >- Specify validation level of ProcessTemplate 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProcessTemplate required: true content: application / json: schema: $ref: '#/components/schemas/createProcessTemplateInput' responses: '201': description: Creation confirmation. Returns created ProcessTemplate content: application/json: schema: $ref: '#/components/schemas/ProcessCreateNewProcessTemplateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v3d5mv8ithth6 /entities/ProcessTemplates/batch-delete: post: tags: - Process summary: ProcessTemplates.batch_delete operationId: Process_removeByIds description: Removes ProcessTemplates with given list of ids parameters: - description: >- Specify validation level of ProcessTemplates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProcessRemoveByIdsRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProcessRemoveByIds200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l5iuwjbfd8f1o /entities/ProcessTemplates/batch-modify: post: tags: - Process summary: ProcessTemplates.batch_create_or_update operationId: Process_modifyBatchProcessTemplates description: Create or update an batch of ProcessTemplates parameters: - description: >- Specify validation level of ProcessTemplates 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProcessTemplates. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProcessTemplate required: true content: application / json: schema: $ref: '#/components/schemas/ProcessModifyBatchProcessTemplatesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProcessTemplates content: application/json: schema: $ref: >- #/components/schemas/ProcessModifyBatchProcessTemplatesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ihy92fwpaqwo9 /entities/Products/{id}: get: tags: - Product summary: Products.get operationId: Product_getById description: Returns Product with given id parameters: - description: ID of Product to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Product data content: application/json: schema: $ref: '#/components/schemas/ProductGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lt4q8p61ra0fn delete: tags: - Product summary: Products.delete operationId: Product_removeById description: Removes Product with given id parameters: - description: ID of Product to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Product 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r6rk2t67yki9l patch: tags: - Product summary: Products.update operationId: Product_modifyById description: Modifies Product or Products with given id(s) parameters: - description: ID of Product to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Product 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductInput' responses: '200': description: Modification confirmation. Returns resulting Product content: application/json: schema: $ref: '#/components/schemas/ProductModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4l54eoccp4621 /entities/Products: get: tags: - Product summary: Products.list operationId: Product_getAllDefined description: Returns all defined Products parameters: - description: if enabled, deleted Products are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Products content: application/json: schema: $ref: '#/components/schemas/ProductGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ex01yb58p3nva post: tags: - Product summary: Products.create operationId: Product_createNewProduct description: Creates new Product parameters: - description: >- Specify validation level of Product 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Product required: true content: application / json: schema: $ref: '#/components/schemas/createProductInput' responses: '201': description: Creation confirmation. Returns created Product content: application/json: schema: $ref: '#/components/schemas/ProductCreateNewProductResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jf7j7bnnzdbni /entities/Products/batch-delete: post: tags: - Product summary: Products.batch_delete operationId: Product_removeBatch description: Removes Products with given list of ids parameters: - description: >- Specify validation level of Products 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sui8ddfg88m0r /entities/Products/batch-modify: post: tags: - Product summary: Products.batch_create_or_update operationId: Product_batchModifyProducts description: Create or update an batch of Products parameters: - description: >- Specify validation level of Products 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Product required: true content: application / json: schema: $ref: '#/components/schemas/ProductBatchModifyProductsRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Products content: application/json: schema: $ref: '#/components/schemas/ProductBatchModifyProductsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bj8w7bzyxo7qe /entities/ProductCategories/{id}: get: tags: - Product summary: ProductCategories.get operationId: Product_getById description: Returns ProductCategory with given id parameters: - description: ID of ProductCategory to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductCategory data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qjv58uybfnmym delete: tags: - Product summary: ProductCategories.delete operationId: Product_removeById description: Removes ProductCategory with given id parameters: - description: ID of ProductCategory to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductCategory 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5jngiw1gpsa0h patch: tags: - Product summary: ProductCategories.update operationId: Product_modifyCategoryById description: Modifies ProductCategory or ProductCategories with given id(s) parameters: - description: ID of ProductCategory to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductCategory 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductCategoryInput' responses: '200': description: Modification confirmation. Returns resulting ProductCategory content: application/json: schema: $ref: '#/components/schemas/ProductModifyCategoryByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cuhf2phha9kg6 /entities/ProductCategories: get: tags: - Product summary: ProductCategories.list operationId: Product_getAllProductCategories description: Returns all defined ProductCategories parameters: - description: if enabled, deleted ProductCategories are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductCategories content: application/json: schema: $ref: '#/components/schemas/ProductGetAllProductCategoriesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qpj2uf6h98xow post: tags: - Product summary: ProductCategories.create operationId: Product_createNewCategory description: Creates new ProductCategory parameters: - description: >- Specify validation level of ProductCategory 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProductCategory required: true content: application / json: schema: $ref: '#/components/schemas/createProductCategoryInput' responses: '201': description: Creation confirmation. Returns created ProductCategory content: application/json: schema: $ref: '#/components/schemas/ProductCreateNewCategoryResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g3hfugu933eep /entities/ProductCategories/batch-delete: post: tags: - Product summary: ProductCategories.batch_delete operationId: Product_removeBatch description: Removes ProductCategories with given list of ids parameters: - description: >- Specify validation level of ProductCategories 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductCategories. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mhazt9lwva6vo /entities/ProductCategories/batch-modify: post: tags: - Product summary: ProductCategories.batch_create_or_update operationId: Product_modifyProductCategoriesBatch description: Create or update an batch of ProductCategories parameters: - description: >- Specify validation level of ProductCategories 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductCategories. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProductCategory required: true content: application / json: schema: $ref: '#/components/schemas/ProductModifyProductCategoriesBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProductCategories content: application/json: schema: $ref: >- #/components/schemas/ProductModifyProductCategoriesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: awimax3oilhlw /entities/ProductDataExRelations/{id}: get: tags: - Product summary: ProductDataExRelations.get operationId: Product_getById description: Returns ProductDataExRelation with given id parameters: - description: ID of ProductDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductDataExRelation data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vucwjki7fr6cr /entities/ProductDataExRelations: get: tags: - Product summary: ProductDataExRelations.list operationId: Product_getAllRelations description: Returns all defined ProductDataExRelations parameters: - description: if enabled, deleted ProductDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductDataExRelations content: application/json: schema: $ref: '#/components/schemas/ProductGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9hki8gscsbiti /entities/ProductPipelineRelations/{id}: get: tags: - Product summary: ProductPipelineRelations.get operationId: Product_getById description: Returns ProductPipelineRelation with given id parameters: - description: ID of ProductPipelineRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductPipelineRelation data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i9e1wlrh5x54z delete: tags: - Product summary: ProductPipelineRelations.delete operationId: Product_removeById description: Removes ProductPipelineRelation with given id parameters: - description: ID of ProductPipelineRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPipelineRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zj1gkjjqr3dn1 patch: tags: - Product summary: ProductPipelineRelations.update operationId: Product_updateRelation description: >- Modifies ProductPipelineRelation or ProductPipelineRelations with given id(s) parameters: - description: ID of ProductPipelineRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPipelineRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductPipelineRelationInput' responses: '200': description: Modification confirmation. Returns resulting ProductPipelineRelation content: application/json: schema: $ref: '#/components/schemas/ProductUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 82l1mmul6j6ys /entities/ProductPipelineRelations: get: tags: - Product summary: ProductPipelineRelations.list operationId: Product_listRelations description: Returns all defined ProductPipelineRelations parameters: - description: if enabled, deleted ProductPipelineRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductPipelineRelations content: application/json: schema: $ref: '#/components/schemas/ProductListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zuoooimish7rs post: tags: - Product summary: ProductPipelineRelations.create operationId: Product_createRelation description: Creates new ProductPipelineRelation parameters: - description: >- Specify validation level of ProductPipelineRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProductPipelineRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProductPipelineRelationInput' responses: '201': description: Creation confirmation. Returns created ProductPipelineRelation content: application/json: schema: $ref: '#/components/schemas/ProductCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g7bw0cfjbo9io /entities/ProductPipelineRelations/batch-delete: post: tags: - Product summary: ProductPipelineRelations.batch_delete operationId: Product_removeBatch description: Removes ProductPipelineRelations with given list of ids parameters: - description: >- Specify validation level of ProductPipelineRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPipelineRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n9h1v3g9hrd4w /entities/ProductPipelineRelations/batch-modify: post: tags: - Product summary: ProductPipelineRelations.batch_create_or_update operationId: Product_modifyBatchProductPipelineRelations description: Create or update an batch of ProductPipelineRelations parameters: - description: >- Specify validation level of ProductPipelineRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPipelineRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProductPipelineRelation required: true content: application / json: schema: $ref: >- #/components/schemas/ProductModifyBatchProductPipelineRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProductPipelineRelations content: application/json: schema: $ref: >- #/components/schemas/ProductModifyBatchProductPipelineRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ff30gozlpys01 /entities/ProductPriceLists/{id}: get: tags: - Product summary: ProductPriceLists.get operationId: Product_getById description: Returns ProductPriceList with given id parameters: - description: ID of ProductPriceList to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductPriceList data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5urkr64l0x7go delete: tags: - Product summary: ProductPriceLists.delete operationId: Product_removeById description: Removes ProductPriceList with given id parameters: - description: ID of ProductPriceList to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPriceList 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: h4gljwfu692mh patch: tags: - Product summary: ProductPriceLists.update operationId: Product_modifyPriceList description: Modifies ProductPriceList or ProductPriceLists with given id(s) parameters: - description: ID of ProductPriceList to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPriceList 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductPriceListInput' responses: '200': description: Modification confirmation. Returns resulting ProductPriceList content: application/json: schema: $ref: '#/components/schemas/ProductModifyPriceListResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hlhdck15hjxf2 /entities/ProductPriceLists: get: tags: - Product summary: ProductPriceLists.list operationId: Product_listProductPriceLists description: Returns all defined ProductPriceLists parameters: - description: if enabled, deleted ProductPriceLists are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductPriceLists content: application/json: schema: $ref: '#/components/schemas/ProductListProductPriceListsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: skyhyyydai9p2 post: tags: - Product summary: ProductPriceLists.create operationId: Product_createNewProductPriceList description: Creates new ProductPriceList parameters: - description: >- Specify validation level of ProductPriceList 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProductPriceList required: true content: application / json: schema: $ref: '#/components/schemas/createProductPriceListInput' responses: '201': description: Creation confirmation. Returns created ProductPriceList content: application/json: schema: $ref: '#/components/schemas/ProductCreateNewProductPriceListResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bjq27fgkg9bji /entities/ProductPriceLists/batch-delete: post: tags: - Product summary: ProductPriceLists.batch_delete operationId: Product_deleteBatch description: Removes ProductPriceLists with given list of ids parameters: - description: >- Specify validation level of ProductPriceLists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPriceLists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductDeleteBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductDeleteBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 95tym3dud5dwu /entities/ProductPriceLists/batch-modify: post: tags: - Product summary: ProductPriceLists.batch_create_or_update operationId: Product_modifyBatchProductPriceLists description: Create or update an batch of ProductPriceLists parameters: - description: >- Specify validation level of ProductPriceLists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPriceLists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProductPriceList required: true content: application / json: schema: $ref: '#/components/schemas/ProductModifyBatchProductPriceListsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProductPriceLists content: application/json: schema: $ref: >- #/components/schemas/ProductModifyBatchProductPriceListsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z9hrbvguodwht /entities/ProductPriceListPrices/{id}: get: tags: - Product summary: ProductPriceListPrices.get operationId: Product_getById description: Returns ProductPriceListPrice with given id parameters: - description: ID of ProductPriceListPrice to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductPriceListPrice data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pvneh8tsc1hn0 delete: tags: - Product summary: ProductPriceListPrices.delete operationId: Product_removeById description: Removes ProductPriceListPrice with given id parameters: - description: ID of ProductPriceListPrice to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPriceListPrice 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 02wg8ecbjihy2 patch: tags: - Product summary: ProductPriceListPrices.update operationId: Product_updatePriceListPrices description: >- Modifies ProductPriceListPrice or ProductPriceListPrices with given id(s) parameters: - description: ID of ProductPriceListPrice to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductPriceListPrice 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductPriceListPriceInput' responses: '200': description: Modification confirmation. Returns resulting ProductPriceListPrice content: application/json: schema: $ref: '#/components/schemas/ProductUpdatePriceListPricesResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vgos57mzh7z4r /entities/ProductPriceListPrices: get: tags: - Product summary: ProductPriceListPrices.list operationId: Product_getAllPrices description: Returns all defined ProductPriceListPrices parameters: - description: if enabled, deleted ProductPriceListPrices are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductPriceListPrices content: application/json: schema: $ref: '#/components/schemas/ProductGetAllPricesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jsco1u30pw93u post: tags: - Product summary: ProductPriceListPrices.create operationId: Product_createPriceListPrice description: Creates new ProductPriceListPrice parameters: - description: >- Specify validation level of ProductPriceListPrice 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProductPriceListPrice required: true content: application / json: schema: $ref: '#/components/schemas/createProductPriceListPriceInput' responses: '201': description: Creation confirmation. Returns created ProductPriceListPrice content: application/json: schema: $ref: '#/components/schemas/ProductCreatePriceListPriceResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q3nfsza5xp00m /entities/ProductPriceListPrices/batch-delete: post: tags: - Product summary: ProductPriceListPrices.batch_delete operationId: Product_removeBatchPrices description: Removes ProductPriceListPrices with given list of ids parameters: - description: >- Specify validation level of ProductPriceListPrices 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPriceListPrices. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductRemoveBatchPricesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveBatchPricesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 750z44ljqe2ph /entities/ProductPriceListPrices/batch-modify: post: tags: - Product summary: ProductPriceListPrices.batch_create_or_update operationId: Product_priceListPricesBatchModify description: Create or update an batch of ProductPriceListPrices parameters: - description: >- Specify validation level of ProductPriceListPrices 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductPriceListPrices. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProductPriceListPrice required: true content: application / json: schema: $ref: '#/components/schemas/ProductPriceListPricesBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProductPriceListPrices content: application/json: schema: $ref: '#/components/schemas/ProductPriceListPricesBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ff4sl4t87vjzo /entities/ProductTypes/{id}: get: tags: - Product summary: ProductTypes.get operationId: Product_getById description: Returns ProductType with given id parameters: - description: ID of ProductType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProductType data content: application/json: schema: $ref: '#/components/schemas/ProductGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sovi5zzodt3di delete: tags: - Product summary: ProductTypes.delete operationId: Product_removeById description: Removes ProductType with given id parameters: - description: ID of ProductType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0yzu8xifuupsv patch: tags: - Product summary: ProductTypes.update operationId: Product_modifyById description: Modifies ProductType or ProductTypes with given id(s) parameters: - description: ID of ProductType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProductType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProductTypeInput' responses: '200': description: Modification confirmation. Returns resulting ProductType content: application/json: schema: $ref: '#/components/schemas/ProductModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8tvmftzc0car2 /entities/ProductTypes: get: tags: - Product summary: ProductTypes.list operationId: Product_getAllProductTypes description: Returns all defined ProductTypes parameters: - description: if enabled, deleted ProductTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProductTypes content: application/json: schema: $ref: '#/components/schemas/ProductGetAllProductTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ktlo34mq6dzim post: tags: - Product summary: ProductTypes.create operationId: Product_createNewProductType description: Creates new ProductType parameters: - description: >- Specify validation level of ProductType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProductType required: true content: application / json: schema: $ref: '#/components/schemas/createProductTypeInput' responses: '201': description: Creation confirmation. Returns created ProductType content: application/json: schema: $ref: '#/components/schemas/ProductCreateNewProductTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nsfnmhe83ckup /entities/ProductTypes/batch-delete: post: tags: - Product summary: ProductTypes.batch_delete operationId: Product_removeBatch description: Removes ProductTypes with given list of ids parameters: - description: >- Specify validation level of ProductTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProductRemoveBatchRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProductRemoveBatch200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rcm3qbp0j9xod /entities/ProductTypes/batch-modify: post: tags: - Product summary: ProductTypes.batch_create_or_update operationId: Product_modifyBatchProductTypes description: Create or update an batch of ProductTypes parameters: - description: >- Specify validation level of ProductTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProductTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProductType required: true content: application / json: schema: $ref: '#/components/schemas/ProductModifyBatchProductTypesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProductTypes content: application/json: schema: $ref: '#/components/schemas/ProductModifyBatchProductTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hrl330r4l19wn /entities/Profiles/{id}: get: tags: - Profile summary: Profiles.get operationId: Profile_getById description: Returns Profile with given id parameters: - description: ID of Profile to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Profile data content: application/json: schema: $ref: '#/components/schemas/ProfileGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rim99e29k2t1r /entities/Profiles: get: tags: - Profile summary: Profiles.list operationId: Profile_getAll description: Returns all defined Profiles parameters: - description: if enabled, deleted Profiles are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Profiles content: application/json: schema: $ref: '#/components/schemas/ProfileGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zvo4o732xx9n9 /entities/ProfileSharingClientRelations/{id}: get: tags: - Profile summary: ProfileSharingClientRelations.get operationId: Profile_getById description: Returns ProfileSharingClientRelation with given id parameters: - description: ID of ProfileSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProfileSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/ProfileGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1emd9shcn8veq /entities/ProfileSharingClientRelations: get: tags: - Profile summary: ProfileSharingClientRelations.list operationId: Profile_getAll description: Returns all defined ProfileSharingClientRelations parameters: - description: >- if enabled, deleted ProfileSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProfileSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/ProfileGetAll200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wg7pje4pzgtae /entities/ProfileSharingSalesUnitRelations/{id}: get: tags: - Profile summary: ProfileSharingSalesUnitRelations.get operationId: Profile_getById description: Returns ProfileSharingSalesUnitRelation with given id parameters: - description: ID of ProfileSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProfileSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/ProfileGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cgii2jvnzp3bc /entities/ProfileSharingSalesUnitRelations: get: tags: - Profile summary: ProfileSharingSalesUnitRelations.list operationId: Profile_listRelations description: Returns all defined ProfileSharingSalesUnitRelations parameters: - description: >- if enabled, deleted ProfileSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProfileSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ProfileListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vmkth2c2b00d7 /entities/Projects/{id}: get: tags: - Project summary: Projects.get operationId: Project_getById description: Returns Project with given id parameters: - description: ID of Project to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Project data content: application/json: schema: $ref: '#/components/schemas/ProjectGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7sbpi1p6w1bwy delete: tags: - Project summary: Projects.delete operationId: Project_removeById description: Removes Project with given id parameters: - description: ID of Project to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Project 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jrid9ml4f211w patch: tags: - Project summary: Projects.update operationId: Project_modifyById description: Modifies Project or Projects with given id(s) parameters: - description: ID of Project to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Project 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectInput' responses: '200': description: Modification confirmation. Returns resulting Project content: application/json: schema: $ref: '#/components/schemas/ProjectModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9vgtu4iz7e47y /entities/Projects: get: tags: - Project summary: Projects.list operationId: Project_getAll description: Returns all defined Projects parameters: - description: if enabled, deleted Projects are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Projects content: application/json: schema: $ref: '#/components/schemas/ProjectGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oxr9jr2jud42r post: tags: - Project summary: Projects.create operationId: Project_createNewProject description: Creates new Project parameters: - description: >- Specify validation level of Project 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Project required: true content: application / json: schema: $ref: '#/components/schemas/createProjectInput' responses: '201': description: Creation confirmation. Returns created Project content: application/json: schema: $ref: '#/components/schemas/ProjectCreateNewProjectResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7968dh1toq0v1 /entities/Projects/batch-delete: post: tags: - Project summary: Projects.batch_delete operationId: Project_removeBatch description: Removes Projects with given list of ids parameters: - description: >- Specify validation level of Projects 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2fc6mot3bk51x /entities/Projects/batch-modify: post: tags: - Project summary: Projects.batch_create_or_update operationId: Project_batchModify description: Create or update an batch of Projects parameters: - description: >- Specify validation level of Projects 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Project required: true content: application / json: schema: $ref: '#/components/schemas/ProjectBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Projects content: application/json: schema: $ref: '#/components/schemas/ProjectBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: byhjpjamfaepj /entities/ProjectContactRelations/{id}: get: tags: - Project summary: ProjectContactRelations.get operationId: Project_getById description: Returns ProjectContactRelation with given id parameters: - description: ID of ProjectContactRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectContactRelation data content: application/json: schema: $ref: '#/components/schemas/ProjectGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 90ltg3tf5onpv delete: tags: - Project summary: ProjectContactRelations.delete operationId: Project_removeById description: Removes ProjectContactRelation with given id parameters: - description: ID of ProjectContactRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectContactRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: c57dlitkozwrl patch: tags: - Project summary: ProjectContactRelations.update operationId: Project_modifyRelation description: >- Modifies ProjectContactRelation or ProjectContactRelations with given id(s) parameters: - description: ID of ProjectContactRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting ProjectContactRelation content: application/json: schema: $ref: '#/components/schemas/ProjectModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pmcaezym836x1 /entities/ProjectContactRelations: get: tags: - Project summary: ProjectContactRelations.list operationId: Project_getAllProjectContactRelations description: Returns all defined ProjectContactRelations parameters: - description: if enabled, deleted ProjectContactRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectContactRelations content: application/json: schema: $ref: >- #/components/schemas/ProjectGetAllProjectContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: aza2n0l1a60gj post: tags: - Project summary: ProjectContactRelations.create operationId: Project_createRelation description: Creates new ProjectContactRelation parameters: - description: >- Specify validation level of ProjectContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectContactRelationInput' responses: '201': description: Creation confirmation. Returns created ProjectContactRelation content: application/json: schema: $ref: '#/components/schemas/ProjectCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nv3rahlqarkea /entities/ProjectContactRelations/batch-delete: post: tags: - Project summary: ProjectContactRelations.batch_delete operationId: Project_removeRelationsBatch description: Removes ProjectContactRelations with given list of ids parameters: - description: >- Specify validation level of ProjectContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveRelationsBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveRelationsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n5cvjo0pew34w /entities/ProjectContactRelations/batch-modify: post: tags: - Project summary: ProjectContactRelations.batch_create_or_update operationId: Project_modifyRelationsBatch description: Create or update an batch of ProjectContactRelations parameters: - description: >- Specify validation level of ProjectContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/ProjectModifyRelationsBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectContactRelations content: application/json: schema: $ref: '#/components/schemas/ProjectModifyRelationsBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: grh4ig7fzjvqc /entities/ProjectDataExRelations/{id}: get: tags: - Project summary: ProjectDataExRelations.get operationId: Project_getExRelationById description: Returns ProjectDataExRelation with given id parameters: - description: ID of ProjectDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectDataExRelation data content: application/json: schema: $ref: '#/components/schemas/ProjectGetExRelationByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f1fq0zafla7dq /entities/ProjectDataExRelations: get: tags: - Project summary: ProjectDataExRelations.list operationId: Project_getAllRelations description: Returns all defined ProjectDataExRelations parameters: - description: if enabled, deleted ProjectDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectDataExRelations content: application/json: schema: $ref: '#/components/schemas/ProjectGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d3rg0zj7wzkwo /entities/ProjectKPIs/{id}: get: tags: - Project summary: ProjectKPIs.get operationId: Project_getKpi description: Returns ProjectKPI with given id parameters: - description: ID of ProjectKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectKPI data content: application/json: schema: $ref: '#/components/schemas/ProjectGetKpiResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hfiw90excl8zi delete: tags: - Project summary: ProjectKPIs.delete operationId: Project_removeById description: Removes ProjectKPI with given id parameters: - description: ID of ProjectKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectKPI 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zuxg8k17scl5c patch: tags: - Project summary: ProjectKPIs.update operationId: Project_modifyKPIById description: Modifies ProjectKPI or ProjectKPIs with given id(s) parameters: - description: ID of ProjectKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectKPIInput' responses: '200': description: Modification confirmation. Returns resulting ProjectKPI content: application/json: schema: $ref: '#/components/schemas/ProjectModifyKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k0y5l5342lfu9 /entities/ProjectKPIs: get: tags: - Project summary: ProjectKPIs.list operationId: Project_getAllKpis description: Returns all defined ProjectKPIs parameters: - description: if enabled, deleted ProjectKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectKPIs content: application/json: schema: $ref: '#/components/schemas/ProjectGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bmqlbbgu7lcmp post: tags: - Project summary: ProjectKPIs.create operationId: Project_createNewProjectKpi description: Creates new ProjectKPI parameters: - description: >- Specify validation level of ProjectKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectKPI required: true content: application / json: schema: $ref: '#/components/schemas/createProjectKPIInput' responses: '201': description: Creation confirmation. Returns created ProjectKPI content: application/json: schema: $ref: '#/components/schemas/ProjectCreateNewProjectKpiResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 19dfjbh33nwev /entities/ProjectKPIs/batch-delete: post: tags: - Project summary: ProjectKPIs.batch_delete operationId: Project_removeBatchKPIs description: Removes ProjectKPIs with given list of ids parameters: - description: >- Specify validation level of ProjectKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveBatchKpIsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveBatchKpIsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n34yw93yf3qj6 /entities/ProjectKPIs/batch-modify: post: tags: - Project summary: ProjectKPIs.batch_create_or_update operationId: Project_modifyBatchProjectKPIs description: Create or update an batch of ProjectKPIs parameters: - description: >- Specify validation level of ProjectKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectKPI required: true content: application / json: schema: $ref: '#/components/schemas/ProjectModifyBatchProjectKpIsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectKPIs content: application/json: schema: $ref: '#/components/schemas/ProjectModifyBatchProjectKpIsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lv4vgiyx8q04u /entities/ProjectObjectives/{id}: get: tags: - Project summary: ProjectObjectives.get operationId: Project_getObjectivesById description: Returns ProjectObjective with given id parameters: - description: ID of ProjectObjective to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectObjective data content: application/json: schema: $ref: '#/components/schemas/ProjectGetObjectivesByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zo2tlru8vqyvv delete: tags: - Project summary: ProjectObjectives.delete operationId: Project_removeById description: Removes ProjectObjective with given id parameters: - description: ID of ProjectObjective to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectObjective 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: h3gie4sdedpbx patch: tags: - Project summary: ProjectObjectives.update operationId: Project_modifyObjectives description: Modifies ProjectObjective or ProjectObjectives with given id(s) parameters: - description: ID of ProjectObjective to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectObjective 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectObjectiveInput' responses: '200': description: Modification confirmation. Returns resulting ProjectObjective content: application/json: schema: $ref: '#/components/schemas/ProjectModifyObjectivesResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j0l8edhkkgatc /entities/ProjectObjectives: get: tags: - Project summary: ProjectObjectives.list operationId: Project_getAllProjectObjectives description: Returns all defined ProjectObjectives parameters: - description: if enabled, deleted ProjectObjectives are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectObjectives content: application/json: schema: $ref: '#/components/schemas/ProjectGetAllProjectObjectivesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ln3ya35hf0iqt post: tags: - Project summary: ProjectObjectives.create operationId: Project_createNewObjective description: Creates new ProjectObjective parameters: - description: >- Specify validation level of ProjectObjective 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectObjective required: true content: application / json: schema: $ref: '#/components/schemas/createProjectObjectiveInput' responses: '201': description: Creation confirmation. Returns created ProjectObjective content: application/json: schema: $ref: '#/components/schemas/ProjectCreateNewObjectiveResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0yw5yx4e4zku8 /entities/ProjectObjectives/batch-delete: post: tags: - Project summary: ProjectObjectives.batch_delete operationId: Project_removeBatchProjectObjectives description: Removes ProjectObjectives with given list of ids parameters: - description: >- Specify validation level of ProjectObjectives 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveBatchProjectObjectivesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ProjectRemoveBatchProjectObjectivesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wyx0tluovpes2 /entities/ProjectObjectives/batch-modify: post: tags: - Project summary: ProjectObjectives.batch_create_or_update operationId: Project_modifyProjectObjectivesBatch description: Create or update an batch of ProjectObjectives parameters: - description: >- Specify validation level of ProjectObjectives 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectObjective required: true content: application / json: schema: $ref: '#/components/schemas/ProjectModifyProjectObjectivesBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectObjectives content: application/json: schema: $ref: >- #/components/schemas/ProjectModifyProjectObjectivesBatchResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: md15cwqyjeb4h /entities/ProjectSharingClientRelations/{id}: get: tags: - Project summary: ProjectSharingClientRelations.get operationId: Project_getById description: Returns ProjectSharingClientRelation with given id parameters: - description: ID of ProjectSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/ProjectGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: spyn5cfqugkfq delete: tags: - Project summary: ProjectSharingClientRelations.delete operationId: Project_removeById description: Removes ProjectSharingClientRelation with given id parameters: - description: ID of ProjectSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kgho8mgcn101k patch: tags: - Project summary: ProjectSharingClientRelations.update operationId: Project_modifyRelation description: >- Modifies ProjectSharingClientRelation or ProjectSharingClientRelations with given id(s) parameters: - description: ID of ProjectSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting ProjectSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/ProjectModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kxcg7yr3ulpwg /entities/ProjectSharingClientRelations: get: tags: - Project summary: ProjectSharingClientRelations.list operationId: Project_getAll description: Returns all defined ProjectSharingClientRelations parameters: - description: >- if enabled, deleted ProjectSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/ProjectGetAll200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v75z8xz4l00qk post: tags: - Project summary: ProjectSharingClientRelations.create operationId: Project_createRelation description: Creates new ProjectSharingClientRelation parameters: - description: >- Specify validation level of ProjectSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created ProjectSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/ProjectCreateRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: t381p4s9k3mgf /entities/ProjectSharingClientRelations/batch-delete: post: tags: - Project summary: ProjectSharingClientRelations.batch_delete operationId: Project_removeBatch description: Removes ProjectSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of ProjectSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y80rzvd2tmpqt /entities/ProjectSharingClientRelations/batch-modify: post: tags: - Project summary: ProjectSharingClientRelations.batch_create_or_update operationId: Project_modifyBatchProjectSharingClientRelations description: Create or update an batch of ProjectSharingClientRelations parameters: - description: >- Specify validation level of ProjectSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectSharingClientRelation required: true content: application / json: schema: $ref: >- #/components/schemas/ProjectModifyBatchProjectSharingClientRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/ProjectModifyBatchProjectSharingClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: toskqf5jo7azq /entities/ProjectSharingSalesUnitRelations/{id}: get: tags: - Project summary: ProjectSharingSalesUnitRelations.get operationId: Project_getById description: Returns ProjectSharingSalesUnitRelation with given id parameters: - description: ID of ProjectSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/ProjectGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: urugm8j4dq2ja delete: tags: - Project summary: ProjectSharingSalesUnitRelations.delete operationId: Project_removeById description: Removes ProjectSharingSalesUnitRelation with given id parameters: - description: ID of ProjectSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 17k8orb3o3u0g patch: tags: - Project summary: ProjectSharingSalesUnitRelations.update operationId: Project_updateRelation description: >- Modifies ProjectSharingSalesUnitRelation or ProjectSharingSalesUnitRelations with given id(s) parameters: - description: ID of ProjectSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting ProjectSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/ProjectUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cx2zcc783spfd /entities/ProjectSharingSalesUnitRelations: get: tags: - Project summary: ProjectSharingSalesUnitRelations.list operationId: Project_listRelations description: Returns all defined ProjectSharingSalesUnitRelations parameters: - description: >- if enabled, deleted ProjectSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ProjectListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v208avojizizy post: tags: - Project summary: ProjectSharingSalesUnitRelations.create operationId: Project_createRelation description: Creates new ProjectSharingSalesUnitRelation parameters: - description: >- Specify validation level of ProjectSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectSharingSalesUnitRelationInput' responses: '201': description: >- Creation confirmation. Returns created ProjectSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/ProjectCreateRelation201Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0zqgyekz6alzj /entities/ProjectSharingSalesUnitRelations/batch-delete: post: tags: - Project summary: ProjectSharingSalesUnitRelations.batch_delete operationId: Project_removeBatchByIds description: Removes ProjectSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of ProjectSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o9yd6lzqjvlwu /entities/ProjectSharingSalesUnitRelations/batch-modify: post: tags: - Project summary: ProjectSharingSalesUnitRelations.batch_create_or_update operationId: Project_updateBatch description: Create or update an batch of ProjectSharingSalesUnitRelations parameters: - description: >- Specify validation level of ProjectSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/ProjectUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ProjectUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: i4th0hj9g84ho /entities/ProjectTypes/{id}: get: tags: - Project summary: ProjectTypes.get operationId: Project_getTypeById description: Returns ProjectType with given id parameters: - description: ID of ProjectType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ProjectType data content: application/json: schema: $ref: '#/components/schemas/ProjectGetTypeByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wxgb7qov023fg delete: tags: - Project summary: ProjectTypes.delete operationId: Project_removeById description: Removes ProjectType with given id parameters: - description: ID of ProjectType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2wmk896ujq8dn patch: tags: - Project summary: ProjectTypes.update operationId: Project_modifyById description: Modifies ProjectType or ProjectTypes with given id(s) parameters: - description: ID of ProjectType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ProjectType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectTypeInput' responses: '200': description: Modification confirmation. Returns resulting ProjectType content: application/json: schema: $ref: '#/components/schemas/ProjectModifyById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ey9bktr6f8f9g /entities/ProjectTypes: get: tags: - Project summary: ProjectTypes.list operationId: Project_getAllProjectTypes description: Returns all defined ProjectTypes parameters: - description: if enabled, deleted ProjectTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectTypes content: application/json: schema: $ref: '#/components/schemas/ProjectGetAllProjectTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: csmq09mpgy5ea post: tags: - Project summary: ProjectTypes.create operationId: Project_createNewProjectType description: Creates new ProjectType parameters: - description: >- Specify validation level of ProjectType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ProjectType required: true content: application / json: schema: $ref: '#/components/schemas/createProjectTypeInput' responses: '201': description: Creation confirmation. Returns created ProjectType content: application/json: schema: $ref: '#/components/schemas/ProjectCreateNewProjectTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ngtu9rcr96cqx /entities/ProjectTypes/batch-delete: post: tags: - Project summary: ProjectTypes.batch_delete operationId: Project_removeByIds description: Removes ProjectTypes with given list of ids parameters: - description: >- Specify validation level of ProjectTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ProjectRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ProjectRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l1fyfrjftwe90 /entities/ProjectTypes/batch-modify: post: tags: - Project summary: ProjectTypes.batch_create_or_update operationId: Project_modifyBatchProjectTypes description: Create or update an batch of ProjectTypes parameters: - description: >- Specify validation level of ProjectTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ProjectType required: true content: application / json: schema: $ref: '#/components/schemas/ProjectModifyBatchProjectTypesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ProjectTypes content: application/json: schema: $ref: '#/components/schemas/ProjectModifyBatchProjectTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ng534l5yilix7 /entities/Quotes/{id}: get: tags: - Quote summary: Quotes.get operationId: Quote_getById description: Returns Quote with given id parameters: - description: ID of Quote to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Quote data content: application/json: schema: $ref: '#/components/schemas/QuoteGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jqmaxs01wrf5d delete: tags: - Quote summary: Quotes.delete operationId: Quote_removeById description: Removes Quote with given id parameters: - description: ID of Quote to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Quote 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 12j725he48pmm patch: tags: - Quote summary: Quotes.update operationId: Quote_modifyById description: Modifies Quote or Quotes with given id(s) parameters: - description: ID of Quote to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Quote 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteInput' responses: '200': description: Modification confirmation. Returns resulting Quote content: application/json: schema: $ref: '#/components/schemas/QuoteModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k2ynk0ky53z2b /entities/Quotes: get: tags: - Quote summary: Quotes.list operationId: Quote_getAllQuotes description: Returns all defined Quotes parameters: - description: if enabled, deleted Quotes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Quotes content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllQuotesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: se7cvr0iof9zy post: tags: - Quote summary: Quotes.create operationId: Quote_registerNewQuote description: Creates new Quote parameters: - description: >- Specify validation level of Quote 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Quote required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteInput' responses: '201': description: Creation confirmation. Returns created Quote content: application/json: schema: $ref: '#/components/schemas/QuoteRegisterNewQuoteResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x52tnq8fxiofj /entities/Quotes/batch-delete: post: tags: - Quote summary: Quotes.batch_delete operationId: Quote_removeBatch description: Removes Quotes with given list of ids parameters: - description: >- Specify validation level of Quotes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Quotes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xhvcms2kabyib /entities/Quotes/batch-modify: post: tags: - Quote summary: Quotes.batch_create_or_update operationId: Quote_batchModify description: Create or update an batch of Quotes parameters: - description: >- Specify validation level of Quotes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Quotes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Quote required: true content: application / json: schema: $ref: '#/components/schemas/QuoteBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Quotes content: application/json: schema: $ref: '#/components/schemas/QuoteBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 194ktkkx70ine /entities/QuoteAccountRelations/{id}: get: tags: - Quote summary: QuoteAccountRelations.get operationId: Quote_getById description: Returns QuoteAccountRelation with given id parameters: - description: ID of QuoteAccountRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteAccountRelation data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yfh2qc7v3vj3y delete: tags: - Quote summary: QuoteAccountRelations.delete operationId: Quote_removeById description: Removes QuoteAccountRelation with given id parameters: - description: ID of QuoteAccountRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ai5f7f1yw7v0w patch: tags: - Quote summary: QuoteAccountRelations.update operationId: Quote_modifyRelation description: Modifies QuoteAccountRelation or QuoteAccountRelations with given id(s) parameters: - description: ID of QuoteAccountRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteAccountRelation content: application/json: schema: $ref: '#/components/schemas/QuoteModifyRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 53i882ts7kxi6 /entities/QuoteAccountRelations: get: tags: - Quote summary: QuoteAccountRelations.list operationId: Quote_getAllQuoteAccountRelations description: Returns all defined QuoteAccountRelations parameters: - description: if enabled, deleted QuoteAccountRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteAccountRelations content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllQuoteAccountRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: pb1skgw4nb41f post: tags: - Quote summary: QuoteAccountRelations.create operationId: Quote_createRelation description: Creates new QuoteAccountRelation parameters: - description: >- Specify validation level of QuoteAccountRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteAccountRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteAccountRelation content: application/json: schema: $ref: '#/components/schemas/QuoteCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y63qc44642wj8 /entities/QuoteAccountRelations/batch-delete: post: tags: - Quote summary: QuoteAccountRelations.batch_delete operationId: Quote_removeBatchByIds description: Removes QuoteAccountRelations with given list of ids parameters: - description: >- Specify validation level of QuoteAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qnxkyia9opsiz /entities/QuoteAccountRelations/batch-modify: post: tags: - Quote summary: QuoteAccountRelations.batch_create_or_update operationId: Quote_modifyBatchQuoteAccountRelations description: Create or update an batch of QuoteAccountRelations parameters: - description: >- Specify validation level of QuoteAccountRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteAccountRelation required: true content: application / json: schema: $ref: >- #/components/schemas/QuoteModifyBatchQuoteAccountRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteAccountRelations content: application/json: schema: $ref: >- #/components/schemas/QuoteModifyBatchQuoteAccountRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: z5uy7qrhfng81 /entities/QuoteContactRelations/{id}: get: tags: - Quote summary: QuoteContactRelations.get operationId: Quote_getById description: Returns QuoteContactRelation with given id parameters: - description: ID of QuoteContactRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteContactRelation data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m8hmeg50avtut delete: tags: - Quote summary: QuoteContactRelations.delete operationId: Quote_removeById description: Removes QuoteContactRelation with given id parameters: - description: ID of QuoteContactRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteContactRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zkxfv1gn8l8yj patch: tags: - Quote summary: QuoteContactRelations.update operationId: Quote_modifyRelation description: Modifies QuoteContactRelation or QuoteContactRelations with given id(s) parameters: - description: ID of QuoteContactRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteContactRelation content: application/json: schema: $ref: '#/components/schemas/QuoteModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 17ydk83ozpv5l /entities/QuoteContactRelations: get: tags: - Quote summary: QuoteContactRelations.list operationId: Quote_getAllQuoteContactRelations description: Returns all defined QuoteContactRelations parameters: - description: if enabled, deleted QuoteContactRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteContactRelations content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllQuoteContactRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gfye9ckx7ur4d post: tags: - Quote summary: QuoteContactRelations.create operationId: Quote_createRelation description: Creates new QuoteContactRelation parameters: - description: >- Specify validation level of QuoteContactRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteContactRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteContactRelation content: application/json: schema: $ref: '#/components/schemas/QuoteCreateRelation201Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p5whh563k7jq9 /entities/QuoteContactRelations/batch-delete: post: tags: - Quote summary: QuoteContactRelations.batch_delete operationId: Quote_removeBatchByIds description: Removes QuoteContactRelations with given list of ids parameters: - description: >- Specify validation level of QuoteContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatchByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8eq2citmihyjf /entities/QuoteContactRelations/batch-modify: post: tags: - Quote summary: QuoteContactRelations.batch_create_or_update operationId: Quote_modifyBatchQuoteContactRelations description: Create or update an batch of QuoteContactRelations parameters: - description: >- Specify validation level of QuoteContactRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteContactRelation required: true content: application / json: schema: $ref: >- #/components/schemas/QuoteModifyBatchQuoteContactRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteContactRelations content: application/json: schema: $ref: >- #/components/schemas/QuoteModifyBatchQuoteContactRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uml7myseg3ymz /entities/QuoteDataExRelations/{id}: get: tags: - Quote summary: QuoteDataExRelations.get operationId: Quote_getById description: Returns QuoteDataExRelation with given id parameters: - description: ID of QuoteDataExRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteDataExRelation data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l68hmnxqb3stn delete: tags: - Quote summary: QuoteDataExRelations.delete operationId: Quote_removeById description: Removes QuoteDataExRelation with given id parameters: - description: ID of QuoteDataExRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yy2mmiovtjkug patch: tags: - Quote summary: QuoteDataExRelations.update operationId: Quote_updateRelation description: Modifies QuoteDataExRelation or QuoteDataExRelations with given id(s) parameters: - description: ID of QuoteDataExRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteDataExRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteDataExRelation content: application/json: schema: $ref: '#/components/schemas/QuoteUpdateRelationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 15xchhlfa6c03 /entities/QuoteDataExRelations: get: tags: - Quote summary: QuoteDataExRelations.list operationId: Quote_getAllRelations description: Returns all defined QuoteDataExRelations parameters: - description: if enabled, deleted QuoteDataExRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteDataExRelations content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uhg9clf6o3667 post: tags: - Quote summary: QuoteDataExRelations.create operationId: Quote_createRelation description: Creates new QuoteDataExRelation parameters: - description: >- Specify validation level of QuoteDataExRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteDataExRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteDataExRelation content: application/json: schema: $ref: '#/components/schemas/QuoteCreateRelation201Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5klal6xvwxelr /entities/QuoteDataExRelations/batch-delete: post: tags: - Quote summary: QuoteDataExRelations.batch_delete operationId: Quote_removeBatch description: Removes QuoteDataExRelations with given list of ids parameters: - description: >- Specify validation level of QuoteDataExRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8nhudh8mmhlru /entities/QuoteDataExRelations/batch-modify: post: tags: - Quote summary: QuoteDataExRelations.batch_create_or_update operationId: Quote_createOrUpdateBatch description: Create or update an batch of QuoteDataExRelations parameters: - description: >- Specify validation level of QuoteDataExRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteDataExRelations content: application/json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dy8invxn356lw /entities/QuoteKPIs/{id}: get: tags: - Quote summary: QuoteKPIs.get operationId: Quote_getById description: Returns QuoteKPI with given id parameters: - description: ID of QuoteKPI to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteKPI data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wdi2zqtncmoqo delete: tags: - Quote summary: QuoteKPIs.delete operationId: Quote_removeById description: Removes QuoteKPI with given id parameters: - description: ID of QuoteKPI to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteKPI 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: njlljo2jvetuj patch: tags: - Quote summary: QuoteKPIs.update operationId: Quote_modifyKPIById description: Modifies QuoteKPI or QuoteKPIs with given id(s) parameters: - description: ID of QuoteKPI to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteKPIInput' responses: '200': description: Modification confirmation. Returns resulting QuoteKPI content: application/json: schema: $ref: '#/components/schemas/QuoteModifyKpiByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bekxafkc6awje /entities/QuoteKPIs: get: tags: - Quote summary: QuoteKPIs.list operationId: Quote_getAllKpis description: Returns all defined QuoteKPIs parameters: - description: if enabled, deleted QuoteKPIs are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteKPIs content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllKpisResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ysvde8ix2vmx1 post: tags: - Quote summary: QuoteKPIs.create operationId: Quote_createNewKPI description: Creates new QuoteKPI parameters: - description: >- Specify validation level of QuoteKPI 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteKPI required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteKPIInput' responses: '201': description: Creation confirmation. Returns created QuoteKPI content: application/json: schema: $ref: '#/components/schemas/QuoteCreateNewKpiResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k4wbv7camtpf3 /entities/QuoteKPIs/batch-delete: post: tags: - Quote summary: QuoteKPIs.batch_delete operationId: Quote_removeBatch description: Removes QuoteKPIs with given list of ids parameters: - description: >- Specify validation level of QuoteKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchRequest2' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatch200Response1' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zlthbzu8wz7dq /entities/QuoteKPIs/batch-modify: post: tags: - Quote summary: QuoteKPIs.batch_create_or_update operationId: Quote_createOrUpdateBatchQuoteKPIs description: Create or update an batch of QuoteKPIs parameters: - description: >- Specify validation level of QuoteKPIs 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteKPIs. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteKPI required: true content: application / json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatchQuoteKpIsRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteKPIs content: application/json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatchQuoteKpIsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7kr8gctemspje /entities/QuoteProcesses/{id}: get: tags: - Quote summary: QuoteProcesses.get operationId: Quote_getById description: Returns QuoteProcess with given id parameters: - description: ID of QuoteProcess to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteProcess data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jr3ji7nfexvvl delete: tags: - Quote summary: QuoteProcesses.delete operationId: Quote_removeById description: Removes QuoteProcess with given id parameters: - description: ID of QuoteProcess to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteProcess 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response4' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g7zpptuzw0kqe patch: tags: - Quote summary: QuoteProcesses.update operationId: Quote_updateProcess description: Modifies QuoteProcess or QuoteProcesses with given id(s) parameters: - description: ID of QuoteProcess to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteProcessInput' responses: '200': description: Modification confirmation. Returns resulting QuoteProcess content: application/json: schema: $ref: '#/components/schemas/QuoteUpdateProcessResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tdb1swvksukxh /entities/QuoteProcesses: get: tags: - Quote summary: QuoteProcesses.list operationId: Quote_getAllProcesses description: Returns all defined QuoteProcesses parameters: - description: if enabled, deleted QuoteProcesses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteProcesses content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllProcessesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xyjz4lmfuj9yf post: tags: - Quote summary: QuoteProcesses.create operationId: Quote_createQuoteProcess description: Creates new QuoteProcess parameters: - description: >- Specify validation level of QuoteProcess 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteProcess required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteProcessInput' responses: '201': description: Creation confirmation. Returns created QuoteProcess content: application/json: schema: $ref: '#/components/schemas/QuoteCreateQuoteProcessResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 25ug242y8ou0e /entities/QuoteProcesses/batch-delete: post: tags: - Quote summary: QuoteProcesses.batch_delete operationId: Quote_removeByIds description: Removes QuoteProcesses with given list of ids parameters: - description: >- Specify validation level of QuoteProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xe83ykg5ak297 /entities/QuoteProcesses/batch-modify: post: tags: - Quote summary: QuoteProcesses.batch_create_or_update operationId: Quote_processBatchModify description: Create or update an batch of QuoteProcesses parameters: - description: >- Specify validation level of QuoteProcesses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteProcesses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteProcess required: true content: application / json: schema: $ref: '#/components/schemas/QuoteProcessBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteProcesses content: application/json: schema: $ref: '#/components/schemas/QuoteProcessBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zjvvqr8ybah9d /entities/QuoteSharingClientRelations/{id}: get: tags: - Quote summary: QuoteSharingClientRelations.get operationId: Quote_getById description: Returns QuoteSharingClientRelation with given id parameters: - description: ID of QuoteSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 5hgdko5icxbn2 delete: tags: - Quote summary: QuoteSharingClientRelations.delete operationId: Quote_removeById description: Removes QuoteSharingClientRelation with given id parameters: - description: ID of QuoteSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response5' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7of4y8dg1yyo4 patch: tags: - Quote summary: QuoteSharingClientRelations.update operationId: Quote_updateRelation description: >- Modifies QuoteSharingClientRelation or QuoteSharingClientRelations with given id(s) parameters: - description: ID of QuoteSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting QuoteSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/QuoteUpdateRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6pusrdbp1wh7c /entities/QuoteSharingClientRelations: get: tags: - Quote summary: QuoteSharingClientRelations.list operationId: Quote_getAll description: Returns all defined QuoteSharingClientRelations parameters: - description: if enabled, deleted QuoteSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tu4cadzfx60r4 post: tags: - Quote summary: QuoteSharingClientRelations.create operationId: Quote_createRelation description: Creates new QuoteSharingClientRelation parameters: - description: >- Specify validation level of QuoteSharingClientRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/QuoteCreateRelation201Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e662ku8h88kcz /entities/QuoteSharingClientRelations/batch-delete: post: tags: - Quote summary: QuoteSharingClientRelations.batch_delete operationId: Quote_removeBatch description: Removes QuoteSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of QuoteSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchRequest3' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatch200Response2' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2h74q84h834tp /entities/QuoteSharingClientRelations/batch-modify: post: tags: - Quote summary: QuoteSharingClientRelations.batch_create_or_update operationId: Quote_createOrUpdateBatch description: Create or update an batch of QuoteSharingClientRelations parameters: - description: >- Specify validation level of QuoteSharingClientRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatchRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/QuoteCreateOrUpdateBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: r19bbcti2wpc9 /entities/QuoteSharingSalesUnitRelations/{id}: get: tags: - Quote summary: QuoteSharingSalesUnitRelations.get operationId: Quote_getById description: Returns QuoteSharingSalesUnitRelation with given id parameters: - description: ID of QuoteSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xuzbdyq0dwg1o delete: tags: - Quote summary: QuoteSharingSalesUnitRelations.delete operationId: Quote_removeById description: Removes QuoteSharingSalesUnitRelation with given id parameters: - description: ID of QuoteSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response6' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fpl0kvcihefjf patch: tags: - Quote summary: QuoteSharingSalesUnitRelations.update operationId: Quote_updateRelation description: >- Modifies QuoteSharingSalesUnitRelation or QuoteSharingSalesUnitRelations with given id(s) parameters: - description: ID of QuoteSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting QuoteSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/QuoteUpdateRelation200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kccmg26efyp5z /entities/QuoteSharingSalesUnitRelations: get: tags: - Quote summary: QuoteSharingSalesUnitRelations.list operationId: Quote_listRelations description: Returns all defined QuoteSharingSalesUnitRelations parameters: - description: >- if enabled, deleted QuoteSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/QuoteListRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: n2wb1o4m3x4c7 post: tags: - Quote summary: QuoteSharingSalesUnitRelations.create operationId: Quote_createRelation description: Creates new QuoteSharingSalesUnitRelation parameters: - description: >- Specify validation level of QuoteSharingSalesUnitRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteSharingSalesUnitRelation content: application/json: schema: $ref: '#/components/schemas/QuoteCreateRelation201Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kee372csbrwm2 /entities/QuoteSharingSalesUnitRelations/batch-delete: post: tags: - Quote summary: QuoteSharingSalesUnitRelations.batch_delete operationId: Quote_removeBatch description: Removes QuoteSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of QuoteSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveBatchRequest4' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveBatch200Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ic8bm5ycv9zah /entities/QuoteSharingSalesUnitRelations/batch-modify: post: tags: - Quote summary: QuoteSharingSalesUnitRelations.batch_create_or_update operationId: Quote_batchCreateOrUpdate description: Create or update an batch of QuoteSharingSalesUnitRelations parameters: - description: >- Specify validation level of QuoteSharingSalesUnitRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/QuoteBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/QuoteBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nlld9jnb1fapt /entities/QuoteTypes/{id}: get: tags: - Quote summary: QuoteTypes.get operationId: Quote_getById description: Returns QuoteType with given id parameters: - description: ID of QuoteType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: QuoteType data content: application/json: schema: $ref: '#/components/schemas/QuoteGetById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bm69eko2ejzql delete: tags: - Quote summary: QuoteTypes.delete operationId: Quote_removeById description: Removes QuoteType with given id parameters: - description: ID of QuoteType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteType 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveById200Response7' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ttb2wymg53qpg patch: tags: - Quote summary: QuoteTypes.update operationId: Quote_updateById description: Modifies QuoteType or QuoteTypes with given id(s) parameters: - description: ID of QuoteType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of QuoteType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteTypeInput' responses: '200': description: Modification confirmation. Returns resulting QuoteType content: application/json: schema: $ref: '#/components/schemas/QuoteUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3myzjn55xsbk6 /entities/QuoteTypes: get: tags: - Quote summary: QuoteTypes.list operationId: Quote_getAllQuoteTypes description: Returns all defined QuoteTypes parameters: - description: if enabled, deleted QuoteTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of QuoteTypes content: application/json: schema: $ref: '#/components/schemas/QuoteGetAllQuoteTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 60xpdwqj00xb2 post: tags: - Quote summary: QuoteTypes.create operationId: Quote_createNewType description: Creates new QuoteType parameters: - description: >- Specify validation level of QuoteType 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new QuoteType required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteTypeInput' responses: '201': description: Creation confirmation. Returns created QuoteType content: application/json: schema: $ref: '#/components/schemas/QuoteCreateNewTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tntodql8u3f9r /entities/QuoteTypes/batch-delete: post: tags: - Quote summary: QuoteTypes.batch_delete operationId: Quote_removeByIds description: Removes QuoteTypes with given list of ids parameters: - description: >- Specify validation level of QuoteTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/QuoteRemoveByIdsRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/QuoteRemoveByIds200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 65ln87p530rkr /entities/QuoteTypes/batch-modify: post: tags: - Quote summary: QuoteTypes.batch_create_or_update operationId: Quote_modifyBatchQuoteTypes description: Create or update an batch of QuoteTypes parameters: - description: >- Specify validation level of QuoteTypes 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for QuoteTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new QuoteType required: true content: application / json: schema: $ref: '#/components/schemas/QuoteModifyBatchQuoteTypesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated QuoteTypes content: application/json: schema: $ref: '#/components/schemas/QuoteModifyBatchQuoteTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0ag5ac0sm60e0 /entities/Reports/{id}: get: tags: - Report summary: Reports.get operationId: Report_getById description: Returns Report with given id parameters: - description: ID of Report to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Report data content: application/json: schema: $ref: '#/components/schemas/ReportGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 42j5tr1sanbo0 /entities/Reports: get: tags: - Report summary: Reports.list operationId: Report_getAllDefined description: Returns all defined Reports parameters: - description: if enabled, deleted Reports are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Reports content: application/json: schema: $ref: '#/components/schemas/ReportGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oh9n4cr4nmpda /entities/ReportFolders/{id}: get: tags: - Report summary: ReportFolders.get operationId: Report_getById description: Returns ReportFolder with given id parameters: - description: ID of ReportFolder to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ReportFolder data content: application/json: schema: $ref: '#/components/schemas/ReportGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ajzqps8mq0hwx /entities/ReportFolders: get: tags: - Report summary: ReportFolders.list operationId: Report_getAllReportFolders description: Returns all defined ReportFolders parameters: - description: if enabled, deleted ReportFolders are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ReportFolders content: application/json: schema: $ref: '#/components/schemas/ReportGetAllReportFoldersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gdvujtg68yj9j /entities/ReportSchedules/{id}: get: tags: - Report summary: ReportSchedules.get operationId: Report_getById description: Returns ReportSchedule with given id parameters: - description: ID of ReportSchedule to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ReportSchedule data content: application/json: schema: $ref: '#/components/schemas/ReportGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wvjdu0fyvc2hl delete: tags: - Report summary: ReportSchedules.delete operationId: Report_removeById description: Removes ReportSchedule with given id parameters: - description: ID of ReportSchedule to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ReportSchedule 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ReportRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 27ddqdezfcigr patch: tags: - Report summary: ReportSchedules.update operationId: Report_modifySchedule description: Modifies ReportSchedule or ReportSchedules with given id(s) parameters: - description: ID of ReportSchedule to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of ReportSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateReportScheduleInput' responses: '200': description: Modification confirmation. Returns resulting ReportSchedule content: application/json: schema: $ref: '#/components/schemas/ReportModifyScheduleResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mzgu2svueahf9 /entities/ReportSchedules: get: tags: - Report summary: ReportSchedules.list operationId: Report_getAllReportSchedules description: Returns all defined ReportSchedules parameters: - description: if enabled, deleted ReportSchedules are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ReportSchedules content: application/json: schema: $ref: '#/components/schemas/ReportGetAllReportSchedulesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: q05yu1zvxlk94 post: tags: - Report summary: ReportSchedules.create operationId: Report_createNewReportSchedule description: Creates new ReportSchedule parameters: - description: >- Specify validation level of ReportSchedule 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new ReportSchedule required: true content: application / json: schema: $ref: '#/components/schemas/createReportScheduleInput' responses: '201': description: Creation confirmation. Returns created ReportSchedule content: application/json: schema: $ref: '#/components/schemas/ReportCreateNewReportScheduleResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: t8t0uiq9pvhrl /entities/ReportSchedules/batch-delete: post: tags: - Report summary: ReportSchedules.batch_delete operationId: Report_removeBatchByIds description: Removes ReportSchedules with given list of ids parameters: - description: >- Specify validation level of ReportSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ReportSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ReportRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ReportRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yydvnxyij909k /entities/ReportSchedules/batch-modify: post: tags: - Report summary: ReportSchedules.batch_create_or_update operationId: Report_modifyBatchReportSchedules description: Create or update an batch of ReportSchedules parameters: - description: >- Specify validation level of ReportSchedules 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for ReportSchedules. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new ReportSchedule required: true content: application / json: schema: $ref: '#/components/schemas/ReportModifyBatchReportSchedulesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated ReportSchedules content: application/json: schema: $ref: '#/components/schemas/ReportModifyBatchReportSchedulesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ubs3m6ool1ngg /entities/ReportSharingClientRelations/{id}: get: tags: - Report summary: ReportSharingClientRelations.get operationId: Report_getById description: Returns ReportSharingClientRelation with given id parameters: - description: ID of ReportSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ReportSharingClientRelation data content: application/json: schema: $ref: '#/components/schemas/ReportGetById200Response2' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ge65vu1usepi9 /entities/ReportSharingClientRelations: get: tags: - Report summary: ReportSharingClientRelations.list operationId: Report_getAllClientRelations description: Returns all defined ReportSharingClientRelations parameters: - description: >- if enabled, deleted ReportSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ReportSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/ReportGetAllClientRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1gvybvvyqyor6 /entities/ReportSharingSalesUnitRelations/{id}: get: tags: - Report summary: ReportSharingSalesUnitRelations.get operationId: Report_getById description: Returns ReportSharingSalesUnitRelation with given id parameters: - description: ID of ReportSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: ReportSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/ReportGetById200Response3' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mjm1pr2fp8gdh /entities/ReportSharingSalesUnitRelations: get: tags: - Report summary: ReportSharingSalesUnitRelations.list operationId: Report_listSalesUnitRelations description: Returns all defined ReportSharingSalesUnitRelations parameters: - description: >- if enabled, deleted ReportSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ReportSharingSalesUnitRelations content: application/json: schema: $ref: '#/components/schemas/ReportListSalesUnitRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ts4hdkscj6cuy /entities/SalesRoles/{id}: get: tags: - SalesRole summary: SalesRoles.get operationId: SalesRole_getById description: Returns SalesRole with given id parameters: - description: ID of SalesRole to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: SalesRole data content: application/json: schema: $ref: '#/components/schemas/SalesRoleGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: cznpe22eshakn delete: tags: - SalesRole summary: SalesRoles.delete operationId: SalesRole_removeById description: Removes SalesRole with given id parameters: - description: ID of SalesRole to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of SalesRole 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/SalesRoleRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ityctmfzosshn patch: tags: - SalesRole summary: SalesRoles.update operationId: SalesRole_modifyById description: Modifies SalesRole or SalesRoles with given id(s) parameters: - description: ID of SalesRole to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of SalesRole 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateSalesRoleInput' responses: '200': description: Modification confirmation. Returns resulting SalesRole content: application/json: schema: $ref: '#/components/schemas/SalesRoleModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gt8cq8ltv551m /entities/SalesRoles: get: tags: - SalesRole summary: SalesRoles.list operationId: SalesRole_getAllRoles description: Returns all defined SalesRoles parameters: - description: if enabled, deleted SalesRoles are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of SalesRoles content: application/json: schema: $ref: '#/components/schemas/SalesRoleGetAllRolesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ob1upz7a53phy post: tags: - SalesRole summary: SalesRoles.create operationId: SalesRole_createNewRole description: Creates new SalesRole parameters: - description: >- Specify validation level of SalesRole 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new SalesRole required: true content: application / json: schema: $ref: '#/components/schemas/createSalesRoleInput' responses: '201': description: Creation confirmation. Returns created SalesRole content: application/json: schema: $ref: '#/components/schemas/SalesRoleCreateNewRoleResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xwf64t8wo909w /entities/SalesRoles/batch-delete: post: tags: - SalesRole summary: SalesRoles.batch_delete operationId: SalesRole_removeBatch description: Removes SalesRoles with given list of ids parameters: - description: >- Specify validation level of SalesRoles 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for SalesRoles. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/SalesRoleRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/SalesRoleRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k34uwo8tkz22f /entities/SalesRoles/batch-modify: post: tags: - SalesRole summary: SalesRoles.batch_create_or_update operationId: SalesRole_modifyBatchSalesRoles description: Create or update an batch of SalesRoles parameters: - description: >- Specify validation level of SalesRoles 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for SalesRoles. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new SalesRole required: true content: application / json: schema: $ref: '#/components/schemas/SalesRoleModifyBatchSalesRolesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated SalesRoles content: application/json: schema: $ref: '#/components/schemas/SalesRoleModifyBatchSalesRolesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vbww51o3f869z /entities/SalesUnits/{id}: get: tags: - SalesUnit summary: SalesUnits.get operationId: SalesUnit_getById description: Returns SalesUnit with given id parameters: - description: ID of SalesUnit to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: SalesUnit data content: application/json: schema: $ref: '#/components/schemas/SalesUnitGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bvdewyq6xi6ga delete: tags: - SalesUnit summary: SalesUnits.delete operationId: SalesUnit_removeById description: Removes SalesUnit with given id parameters: - description: ID of SalesUnit to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of SalesUnit 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/SalesUnitRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ttfozvhubvwuz patch: tags: - SalesUnit summary: SalesUnits.update operationId: SalesUnit_modifyByIds description: Modifies SalesUnit or SalesUnits with given id(s) parameters: - description: ID of SalesUnit to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of SalesUnit 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateSalesUnitInput' responses: '200': description: Modification confirmation. Returns resulting SalesUnit content: application/json: schema: $ref: '#/components/schemas/SalesUnitModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fbemc2mwillkp /entities/SalesUnits: get: tags: - SalesUnit summary: SalesUnits.list operationId: SalesUnit_listAll description: Returns all defined SalesUnits parameters: - description: if enabled, deleted SalesUnits are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of SalesUnits content: application/json: schema: $ref: '#/components/schemas/SalesUnitListAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d91mqv3pywdh1 post: tags: - SalesUnit summary: SalesUnits.create operationId: SalesUnit_generateNew description: Creates new SalesUnit parameters: - description: >- Specify validation level of SalesUnit 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new SalesUnit required: true content: application / json: schema: $ref: '#/components/schemas/createSalesUnitInput' responses: '201': description: Creation confirmation. Returns created SalesUnit content: application/json: schema: $ref: '#/components/schemas/SalesUnitGenerateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mzx6s5iuicwse /entities/SalesUnits/batch-delete: post: tags: - SalesUnit summary: SalesUnits.batch_delete operationId: SalesUnit_removeBatch description: Removes SalesUnits with given list of ids parameters: - description: >- Specify validation level of SalesUnits 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for SalesUnits. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/SalesUnitRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/SalesUnitRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: b52kjg7n1lq5i /entities/SalesUnits/batch-modify: post: tags: - SalesUnit summary: SalesUnits.batch_create_or_update operationId: SalesUnit_modifyBatchSalesUnits description: Create or update an batch of SalesUnits parameters: - description: >- Specify validation level of SalesUnits 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for SalesUnits. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new SalesUnit required: true content: application / json: schema: $ref: '#/components/schemas/SalesUnitModifyBatchSalesUnitsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated SalesUnits content: application/json: schema: $ref: '#/components/schemas/SalesUnitModifyBatchSalesUnitsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: anuffk4v2spcn /entities/SalesUnitClientRelations/{id}: get: tags: - SalesUnit summary: SalesUnitClientRelations.get operationId: SalesUnit_getById description: Returns SalesUnitClientRelation with given id parameters: - description: ID of SalesUnitClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: SalesUnitClientRelation data content: application/json: schema: $ref: '#/components/schemas/SalesUnitGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: my9hvcu6dme6p /entities/SalesUnitClientRelations: get: tags: - SalesUnit summary: SalesUnitClientRelations.list operationId: SalesUnit_getAllRelations description: Returns all defined SalesUnitClientRelations parameters: - description: if enabled, deleted SalesUnitClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of SalesUnitClientRelations content: application/json: schema: $ref: '#/components/schemas/SalesUnitGetAllRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: frqwe5l1tzpr0 /entities/Steps/{id}: get: tags: - Step summary: Steps.get operationId: Step_getById description: Returns Step with given id parameters: - description: ID of Step to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Step data content: application/json: schema: $ref: '#/components/schemas/StepGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 40fxofseno46y delete: tags: - Step summary: Steps.delete operationId: Step_removeById description: Removes Step with given id parameters: - description: ID of Step to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Step 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 49xud04mupsix patch: tags: - Step summary: Steps.update operationId: Step_modifyById description: Modifies Step or Steps with given id(s) parameters: - description: ID of Step to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Step 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateStepInput' responses: '200': description: Modification confirmation. Returns resulting Step content: application/json: schema: $ref: '#/components/schemas/StepModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 7es7ezky397ex /entities/Steps: get: tags: - Step summary: Steps.list operationId: Step_getAll description: Returns all defined Steps parameters: - description: if enabled, deleted Steps are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Steps content: application/json: schema: $ref: '#/components/schemas/StepGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 114k88btcxki0 post: tags: - Step summary: Steps.create operationId: Step_addNew description: Creates new Step parameters: - description: >- Specify validation level of Step 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Step required: true content: application / json: schema: $ref: '#/components/schemas/createStepInput' responses: '201': description: Creation confirmation. Returns created Step content: application/json: schema: $ref: '#/components/schemas/StepAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zhtbkvyfe7dxl /entities/Steps/batch-delete: post: tags: - Step summary: Steps.batch_delete operationId: Step_removeBatch description: Removes Steps with given list of ids parameters: - description: >- Specify validation level of Steps 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Steps. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/StepRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xinzfzoeh50hp /entities/Steps/batch-modify: post: tags: - Step summary: Steps.batch_create_or_update operationId: Step_batchModify description: Create or update an batch of Steps parameters: - description: >- Specify validation level of Steps 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Steps. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Step required: true content: application / json: schema: $ref: '#/components/schemas/StepBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Steps content: application/json: schema: $ref: '#/components/schemas/StepBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 16wz5m26ybw1x /entities/StepChecklists/{id}: get: tags: - Step summary: StepChecklists.get operationId: Step_getById description: Returns StepChecklist with given id parameters: - description: ID of StepChecklist to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: StepChecklist data content: application/json: schema: $ref: '#/components/schemas/StepGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 36ztcay0zvm5v delete: tags: - Step summary: StepChecklists.delete operationId: Step_removeById description: Removes StepChecklist with given id parameters: - description: ID of StepChecklist to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of StepChecklist 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qm02ci9zoetrh patch: tags: - Step summary: StepChecklists.update operationId: Step_modifyChecklistById description: Modifies StepChecklist or StepChecklists with given id(s) parameters: - description: ID of StepChecklist to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of StepChecklist 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateStepChecklistInput' responses: '200': description: Modification confirmation. Returns resulting StepChecklist content: application/json: schema: $ref: '#/components/schemas/StepModifyChecklistByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nvuprw8q15np1 /entities/StepChecklists: get: tags: - Step summary: StepChecklists.list operationId: Step_getAllStepChecklists description: Returns all defined StepChecklists parameters: - description: if enabled, deleted StepChecklists are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of StepChecklists content: application/json: schema: $ref: '#/components/schemas/StepGetAllStepChecklistsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: bc7pjxngf7avf post: tags: - Step summary: StepChecklists.create operationId: Step_createStepChecklist description: Creates new StepChecklist parameters: - description: >- Specify validation level of StepChecklist 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new StepChecklist required: true content: application / json: schema: $ref: '#/components/schemas/createStepChecklistInput' responses: '201': description: Creation confirmation. Returns created StepChecklist content: application/json: schema: $ref: '#/components/schemas/StepCreateStepChecklistResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 304m398bdurj0 /entities/StepChecklists/batch-delete: post: tags: - Step summary: StepChecklists.batch_delete operationId: Step_removeBatchByIds description: Removes StepChecklists with given list of ids parameters: - description: >- Specify validation level of StepChecklists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for StepChecklists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/StepRemoveBatchByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveBatchByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oheomo1icxy2k /entities/StepChecklists/batch-modify: post: tags: - Step summary: StepChecklists.batch_create_or_update operationId: Step_modifyBatchChecklists description: Create or update an batch of StepChecklists parameters: - description: >- Specify validation level of StepChecklists 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for StepChecklists. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new StepChecklist required: true content: application / json: schema: $ref: '#/components/schemas/StepModifyBatchChecklistsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated StepChecklists content: application/json: schema: $ref: '#/components/schemas/StepModifyBatchChecklistsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wr1jg48cjgyjs /entities/StepChecklistSalesRoleRelations/{id}: get: tags: - Step summary: StepChecklistSalesRoleRelations.get operationId: Step_getById description: Returns StepChecklistSalesRoleRelation with given id parameters: - description: ID of StepChecklistSalesRoleRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: StepChecklistSalesRoleRelation data content: application/json: schema: $ref: '#/components/schemas/StepGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 03en1unomjt75 delete: tags: - Step summary: StepChecklistSalesRoleRelations.delete operationId: Step_removeById description: Removes StepChecklistSalesRoleRelation with given id parameters: - description: ID of StepChecklistSalesRoleRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of StepChecklistSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6xhc3pk4twmlq patch: tags: - Step summary: StepChecklistSalesRoleRelations.update operationId: Step_modifySalesRoleRelations description: >- Modifies StepChecklistSalesRoleRelation or StepChecklistSalesRoleRelations with given id(s) parameters: - description: ID of StepChecklistSalesRoleRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of StepChecklistSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateStepChecklistSalesRoleRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting StepChecklistSalesRoleRelation content: application/json: schema: $ref: '#/components/schemas/StepModifySalesRoleRelationsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yf0phipl9sdj2 /entities/StepChecklistSalesRoleRelations: get: tags: - Step summary: StepChecklistSalesRoleRelations.list operationId: Step_getAllDefined description: Returns all defined StepChecklistSalesRoleRelations parameters: - description: >- if enabled, deleted StepChecklistSalesRoleRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of StepChecklistSalesRoleRelations content: application/json: schema: $ref: '#/components/schemas/StepGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: yfjq1vn35uf06 post: tags: - Step summary: StepChecklistSalesRoleRelations.create operationId: Step_createRelation description: Creates new StepChecklistSalesRoleRelation parameters: - description: >- Specify validation level of StepChecklistSalesRoleRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new StepChecklistSalesRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/createStepChecklistSalesRoleRelationInput' responses: '201': description: >- Creation confirmation. Returns created StepChecklistSalesRoleRelation content: application/json: schema: $ref: '#/components/schemas/StepCreateRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 84233tb7kslp0 /entities/StepChecklistSalesRoleRelations/batch-delete: post: tags: - Step summary: StepChecklistSalesRoleRelations.batch_delete operationId: Step_removeByIds description: Removes StepChecklistSalesRoleRelations with given list of ids parameters: - description: >- Specify validation level of StepChecklistSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for StepChecklistSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/StepRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/StepRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tjy56c2x580mq /entities/StepChecklistSalesRoleRelations/batch-modify: post: tags: - Step summary: StepChecklistSalesRoleRelations.batch_create_or_update operationId: Step_modifyBatchStepChecklistSalesRoleRelations description: Create or update an batch of StepChecklistSalesRoleRelations parameters: - description: >- Specify validation level of StepChecklistSalesRoleRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for StepChecklistSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new StepChecklistSalesRoleRelation required: true content: application / json: schema: $ref: >- #/components/schemas/StepModifyBatchStepChecklistSalesRoleRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated StepChecklistSalesRoleRelations content: application/json: schema: $ref: >- #/components/schemas/StepModifyBatchStepChecklistSalesRoleRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dvpooq8v0735f /entities/Tags/{id}: get: tags: - Tag summary: Tags.get operationId: Tag_getById description: Returns Tag with given id parameters: - description: ID of Tag to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Tag data content: application/json: schema: $ref: '#/components/schemas/TagGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: flbgo1ahip29g delete: tags: - Tag summary: Tags.delete operationId: Tag_removeById description: Removes Tag with given id parameters: - description: ID of Tag to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Tag 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TagRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d0qk6rwzr0rtu patch: tags: - Tag summary: Tags.update operationId: Tag_modifyById description: Modifies Tag or Tags with given id(s) parameters: - description: ID of Tag to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Tag 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTagInput' responses: '200': description: Modification confirmation. Returns resulting Tag content: application/json: schema: $ref: '#/components/schemas/TagModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xk6q3u9s2goy4 /entities/Tags: get: tags: - Tag summary: Tags.list operationId: Tag_getAll description: Returns all defined Tags parameters: - description: if enabled, deleted Tags are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Tags content: application/json: schema: $ref: '#/components/schemas/TagGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mdgkrficpprku post: tags: - Tag summary: Tags.create operationId: Tag_addNew description: Creates new Tag parameters: - description: >- Specify validation level of Tag 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Tag required: true content: application / json: schema: $ref: '#/components/schemas/createTagInput' responses: '201': description: Creation confirmation. Returns created Tag content: application/json: schema: $ref: '#/components/schemas/TagAddNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gl8ydav3zp13w /entities/Tags/batch-delete: post: tags: - Tag summary: Tags.batch_delete operationId: Tag_removeBatch description: Removes Tags with given list of ids parameters: - description: >- Specify validation level of Tags 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Tags. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TagRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TagRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 0eirf00d1p9kb /entities/Tags/batch-modify: post: tags: - Tag summary: Tags.batch_create_or_update operationId: Tag_batchModify description: Create or update an batch of Tags parameters: - description: >- Specify validation level of Tags 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Tags. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Tag required: true content: application / json: schema: $ref: '#/components/schemas/TagBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Tags content: application/json: schema: $ref: '#/components/schemas/TagBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ugih4y49z8ia3 /entities/TagRelations/{id}: get: tags: - Tag summary: TagRelations.get operationId: Tag_getById description: Returns TagRelation with given id parameters: - description: ID of TagRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TagRelation data content: application/json: schema: $ref: '#/components/schemas/TagGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2eb3cckamx4bh delete: tags: - Tag summary: TagRelations.delete operationId: Tag_removeById description: Removes TagRelation with given id parameters: - description: ID of TagRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TagRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TagRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qxipz41qc4rho patch: tags: - Tag summary: TagRelations.update operationId: Tag_modifyTagRelations description: Modifies TagRelation or TagRelations with given id(s) parameters: - description: ID of TagRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TagRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTagRelationInput' responses: '200': description: Modification confirmation. Returns resulting TagRelation content: application/json: schema: $ref: '#/components/schemas/TagModifyTagRelationsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 25ie07fpkjmam /entities/TagRelations: get: tags: - Tag summary: TagRelations.list operationId: Tag_getAllTagRelations description: Returns all defined TagRelations parameters: - description: if enabled, deleted TagRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TagRelations content: application/json: schema: $ref: '#/components/schemas/TagGetAllTagRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: kvykk7o398v9p post: tags: - Tag summary: TagRelations.create operationId: Tag_createNewTagRelation description: Creates new TagRelation parameters: - description: >- Specify validation level of TagRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TagRelation required: true content: application / json: schema: $ref: '#/components/schemas/createTagRelationInput' responses: '201': description: Creation confirmation. Returns created TagRelation content: application/json: schema: $ref: '#/components/schemas/TagCreateNewTagRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xds56y1k4rjgg /entities/TagRelations/batch-delete: post: tags: - Tag summary: TagRelations.batch_delete operationId: Tag_removeBatchTagRelations description: Removes TagRelations with given list of ids parameters: - description: >- Specify validation level of TagRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TagRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TagRemoveBatchTagRelationsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TagRemoveBatchTagRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tr18g161skl1l /entities/TagRelations/batch-modify: post: tags: - Tag summary: TagRelations.batch_create_or_update operationId: Tag_modifyBatchTagRelations description: Create or update an batch of TagRelations parameters: - description: >- Specify validation level of TagRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TagRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TagRelation required: true content: application / json: schema: $ref: '#/components/schemas/TagModifyBatchTagRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TagRelations content: application/json: schema: $ref: '#/components/schemas/TagModifyBatchTagRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4483o2dtt1tip /entities/Targets/{id}: get: tags: - Target summary: Targets.get operationId: Target_getById description: Returns Target with given id parameters: - description: ID of Target to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Target data content: application/json: schema: $ref: '#/components/schemas/TargetGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: suxw34w2lnzqb delete: tags: - Target summary: Targets.delete operationId: Target_removeById description: Removes Target with given id parameters: - description: ID of Target to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Target 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TargetRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l05dr0jwj3zbb patch: tags: - Target summary: Targets.update operationId: Target_modifyById description: Modifies Target or Targets with given id(s) parameters: - description: ID of Target to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Target 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTargetInput' responses: '200': description: Modification confirmation. Returns resulting Target content: application/json: schema: $ref: '#/components/schemas/TargetModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ttn105dzi06qe /entities/Targets: get: tags: - Target summary: Targets.list operationId: Target_getAll description: Returns all defined Targets parameters: - description: if enabled, deleted Targets are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Targets content: application/json: schema: $ref: '#/components/schemas/TargetGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 71dde20r0wzwe post: tags: - Target summary: Targets.create operationId: Target_createNew description: Creates new Target parameters: - description: >- Specify validation level of Target 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Target required: true content: application / json: schema: $ref: '#/components/schemas/createTargetInput' responses: '201': description: Creation confirmation. Returns created Target content: application/json: schema: $ref: '#/components/schemas/TargetCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mwqp3tz3bjkrt /entities/Targets/batch-delete: post: tags: - Target summary: Targets.batch_delete operationId: Target_removeBatch description: Removes Targets with given list of ids parameters: - description: >- Specify validation level of Targets 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Targets. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TargetRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TargetRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m4bt9nht95me9 /entities/Targets/batch-modify: post: tags: - Target summary: Targets.batch_create_or_update operationId: Target_batchModify description: Create or update an batch of Targets parameters: - description: >- Specify validation level of Targets 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Targets. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Target required: true content: application / json: schema: $ref: '#/components/schemas/TargetBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Targets content: application/json: schema: $ref: '#/components/schemas/TargetBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ukqiodw02kaxb /entities/TargetRelations/{id}: get: tags: - Target summary: TargetRelations.get operationId: Target_getById description: Returns TargetRelation with given id parameters: - description: ID of TargetRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TargetRelation data content: application/json: schema: $ref: '#/components/schemas/TargetGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: rrvxu28nmt9ty delete: tags: - Target summary: TargetRelations.delete operationId: Target_removeById description: Removes TargetRelation with given id parameters: - description: ID of TargetRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TargetRelation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TargetRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qgrj19zffcme5 patch: tags: - Target summary: TargetRelations.update operationId: Target_modifyByIds description: Modifies TargetRelation or TargetRelations with given id(s) parameters: - description: ID of TargetRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TargetRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTargetRelationInput' responses: '200': description: Modification confirmation. Returns resulting TargetRelation content: application/json: schema: $ref: '#/components/schemas/TargetModifyByIdsResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: voxlnrtdm6mr6 /entities/TargetRelations: get: tags: - Target summary: TargetRelations.list operationId: Target_getAllDefined description: Returns all defined TargetRelations parameters: - description: if enabled, deleted TargetRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TargetRelations content: application/json: schema: $ref: '#/components/schemas/TargetGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fsyt8kdbp7pvl post: tags: - Target summary: TargetRelations.create operationId: Target_createNewRelation description: Creates new TargetRelation parameters: - description: >- Specify validation level of TargetRelation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TargetRelation required: true content: application / json: schema: $ref: '#/components/schemas/createTargetRelationInput' responses: '201': description: Creation confirmation. Returns created TargetRelation content: application/json: schema: $ref: '#/components/schemas/TargetCreateNewRelationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fcjpu4akzdbk1 /entities/TargetRelations/batch-delete: post: tags: - Target summary: TargetRelations.batch_delete operationId: Target_removeBatch description: Removes TargetRelations with given list of ids parameters: - description: >- Specify validation level of TargetRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TargetRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TargetRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TargetRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3u63bdqt53xtc /entities/TargetRelations/batch-modify: post: tags: - Target summary: TargetRelations.batch_create_or_update operationId: Target_modifyBatchRelations description: Create or update an batch of TargetRelations parameters: - description: >- Specify validation level of TargetRelations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TargetRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TargetRelation required: true content: application / json: schema: $ref: '#/components/schemas/TargetModifyBatchRelationsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TargetRelations content: application/json: schema: $ref: '#/components/schemas/TargetModifyBatchRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: arz9gbspex3iy /entities/Tasks/{id}: get: tags: - Activity summary: Tasks.get operationId: Activity_getById description: Returns Task with given id parameters: - description: ID of Task to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Task data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 1ucfc8p39d9jj delete: tags: - Activity summary: Tasks.delete operationId: Activity_removeById description: Removes Task with given id parameters: - description: ID of Task to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Task on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response8' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e4dmov2ui28s7 patch: tags: - Activity summary: Tasks.update operationId: Activity_modifyTask description: Modifies Task or Tasks with given id(s) parameters: - description: ID of Task to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Task on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskInput' responses: '200': description: Modification confirmation. Returns resulting Task content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y7shm04qa16vj /entities/Tasks: get: tags: - Activity summary: Tasks.list operationId: Activity_getAllDefinedTasks description: Returns all defined Tasks parameters: - description: if enabled, deleted Tasks are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Tasks content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllDefinedTasksResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hkyrp6x2qami7 post: tags: - Activity summary: Tasks.create operationId: Activity_addTask description: Creates new Task parameters: - description: >- Specify validation level of Task on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Task required: true content: application / json: schema: $ref: '#/components/schemas/createTaskInput' responses: '201': description: Creation confirmation. Returns created Task content: application/json: schema: $ref: '#/components/schemas/ActivityAddTaskResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vp91xyydb221a /entities/Tasks/batch-delete: post: tags: - Activity summary: Tasks.batch_delete operationId: Activity_removeBatchTasks description: Removes Tasks with given list of ids parameters: - description: >- Specify validation level of Tasks on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Tasks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchTasksRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatchTasksResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: j42zx0ice52c1 /entities/Tasks/batch-modify: post: tags: - Activity summary: Tasks.batch_create_or_update operationId: Activity_batchModifyTasks description: Create or update an batch of Tasks parameters: - description: >- Specify validation level of Tasks on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Tasks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Task required: true content: application / json: schema: $ref: '#/components/schemas/ActivityBatchModifyTasksRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Tasks content: application/json: schema: $ref: '#/components/schemas/ActivityBatchModifyTasksResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nybowuv4acdkm /entities/TaskRecurrences/{id}: get: tags: - Activity summary: TaskRecurrences.get operationId: Activity_getById description: Returns TaskRecurrence with given id parameters: - description: ID of TaskRecurrence to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TaskRecurrence data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response11' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: x2uw0sjn66ixw delete: tags: - Activity summary: TaskRecurrences.delete operationId: Activity_removeById description: Removes TaskRecurrence with given id parameters: - description: ID of TaskRecurrence to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskRecurrence on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response9' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 21nqm323pr5lt patch: tags: - Activity summary: TaskRecurrences.update operationId: Activity_modifyTaskRecurrence description: Modifies TaskRecurrence or TaskRecurrences with given id(s) parameters: - description: ID of TaskRecurrence to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskRecurrence on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskRecurrenceInput' responses: '200': description: Modification confirmation. Returns resulting TaskRecurrence content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskRecurrenceResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y6nhowdcovpd1 /entities/TaskRecurrences: get: tags: - Activity summary: TaskRecurrences.list operationId: Activity_getAllTaskRecurrences description: Returns all defined TaskRecurrences parameters: - description: if enabled, deleted TaskRecurrences are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TaskRecurrences content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllTaskRecurrencesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4xtvl471s0lfn post: tags: - Activity summary: TaskRecurrences.create operationId: Activity_createTaskRecurrence description: Creates new TaskRecurrence parameters: - description: >- Specify validation level of TaskRecurrence on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TaskRecurrence required: true content: application / json: schema: $ref: '#/components/schemas/createTaskRecurrenceInput' responses: '201': description: Creation confirmation. Returns created TaskRecurrence content: application/json: schema: $ref: '#/components/schemas/ActivityCreateTaskRecurrenceResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k8ru7q71sou41 /entities/TaskRecurrences/batch-delete: post: tags: - Activity summary: TaskRecurrences.batch_delete operationId: Activity_removeTaskRecurrences description: Removes TaskRecurrences with given list of ids parameters: - description: >- Specify validation level of TaskRecurrences on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskRecurrences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveTaskRecurrencesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveTaskRecurrencesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: hjddut6dznz5z /entities/TaskRecurrences/batch-modify: post: tags: - Activity summary: TaskRecurrences.batch_create_or_update operationId: Activity_modifyBatchTaskRecurrences description: Create or update an batch of TaskRecurrences parameters: - description: >- Specify validation level of TaskRecurrences on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskRecurrences. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TaskRecurrence required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyBatchTaskRecurrencesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TaskRecurrences content: application/json: schema: $ref: >- #/components/schemas/ActivityModifyBatchTaskRecurrencesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 40ogge9tt41dz /entities/TaskReminders/{id}: get: tags: - Activity summary: TaskReminders.get operationId: Activity_getTaskReminder description: Returns TaskReminder with given id parameters: - description: ID of TaskReminder to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TaskReminder data content: application/json: schema: $ref: '#/components/schemas/ActivityGetTaskReminderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zdbkkf79lu5mg delete: tags: - Activity summary: TaskReminders.delete operationId: Activity_removeTaskReminder description: Removes TaskReminder with given id parameters: - description: ID of TaskReminder to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskReminder on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveTaskReminderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jjfm1xq9a9yqo patch: tags: - Activity summary: TaskReminders.update operationId: Activity_modifyTaskReminder description: Modifies TaskReminder or TaskReminders with given id(s) parameters: - description: ID of TaskReminder to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskReminder on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskReminderInput' responses: '200': description: Modification confirmation. Returns resulting TaskReminder content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskReminderResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lvt7pw1875tjh /entities/TaskReminders: get: tags: - Activity summary: TaskReminders.list operationId: Activity_getAllTaskReminders description: Returns all defined TaskReminders parameters: - description: if enabled, deleted TaskReminders are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TaskReminders content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllTaskRemindersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 03bjsf9uqct8y post: tags: - Activity summary: TaskReminders.create operationId: Activity_action description: Creates new TaskReminder parameters: - description: >- Specify validation level of TaskReminder on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TaskReminder required: true content: application / json: schema: $ref: '#/components/schemas/createTaskReminderInput' responses: '201': description: Creation confirmation. Returns created TaskReminder content: application/json: schema: $ref: '#/components/schemas/ActivityActionResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4d3i6bmagm963 /entities/TaskReminders/batch-delete: post: tags: - Activity summary: TaskReminders.batch_delete operationId: Activity_removeTaskReminders description: Removes TaskReminders with given list of ids parameters: - description: >- Specify validation level of TaskReminders on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskReminders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveTaskRemindersRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveTaskRemindersResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tpj8csrqzv2ov /entities/TaskReminders/batch-modify: post: tags: - Activity summary: TaskReminders.batch_create_or_update operationId: Activity_modifyTaskBatch description: Create or update an batch of TaskReminders parameters: - description: >- Specify validation level of TaskReminders on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskReminders. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TaskReminder required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyTaskBatchRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TaskReminders content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: eacqxflo3t7w8 /entities/TaskSharingClientRelations/{id}: get: tags: - Activity summary: TaskSharingClientRelations.get operationId: Activity_getTaskSharingClientRelation description: Returns TaskSharingClientRelation with given id parameters: - description: ID of TaskSharingClientRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TaskSharingClientRelation data content: application/json: schema: $ref: >- #/components/schemas/ActivityGetTaskSharingClientRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oxkprkfvf1v4f delete: tags: - Activity summary: TaskSharingClientRelations.delete operationId: Activity_removeById description: Removes TaskSharingClientRelation with given id parameters: - description: ID of TaskSharingClientRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response10' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: csef58dqoloqc patch: tags: - Activity summary: TaskSharingClientRelations.update operationId: Activity_modifyRelation description: >- Modifies TaskSharingClientRelation or TaskSharingClientRelations with given id(s) parameters: - description: ID of TaskSharingClientRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskSharingClientRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting TaskSharingClientRelation content: application/json: schema: $ref: '#/components/schemas/ActivityModifyRelation200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p7p6i0zdq3dzm /entities/TaskSharingClientRelations: get: tags: - Activity summary: TaskSharingClientRelations.list operationId: Activity_getAllTaskSharingClientRelations description: Returns all defined TaskSharingClientRelations parameters: - description: if enabled, deleted TaskSharingClientRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TaskSharingClientRelations content: application/json: schema: $ref: >- #/components/schemas/ActivityGetAllTaskSharingClientRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jqlucjet5wbsy post: tags: - Activity summary: TaskSharingClientRelations.create operationId: Activity_createNewTaskSharingClientRelation description: Creates new TaskSharingClientRelation parameters: - description: >- Specify validation level of TaskSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TaskSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createTaskSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created TaskSharingClientRelation content: application/json: schema: $ref: >- #/components/schemas/ActivityCreateNewTaskSharingClientRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: l8fp6g9kfql87 /entities/TaskSharingClientRelations/batch-delete: post: tags: - Activity summary: TaskSharingClientRelations.batch_delete operationId: Activity_removeBatch description: Removes TaskSharingClientRelations with given list of ids parameters: - description: >- Specify validation level of TaskSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchRequest4' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatch200Response3' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: p7ipu6xq8dm05 /entities/TaskSharingClientRelations/batch-modify: post: tags: - Activity summary: TaskSharingClientRelations.batch_create_or_update operationId: Activity_createOrUpdateBatch description: Create or update an batch of TaskSharingClientRelations parameters: - description: >- Specify validation level of TaskSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TaskSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/ActivityCreateOrUpdateBatchRequest1' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TaskSharingClientRelations content: application/json: schema: $ref: '#/components/schemas/ActivityCreateOrUpdateBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o3vjho8w2tpfg /entities/TaskSharingSalesUnitRelations/{id}: get: tags: - Activity summary: TaskSharingSalesUnitRelations.get operationId: Activity_getById description: Returns TaskSharingSalesUnitRelation with given id parameters: - description: ID of TaskSharingSalesUnitRelation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TaskSharingSalesUnitRelation data content: application/json: schema: $ref: '#/components/schemas/ActivityGetById200Response12' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: zf8gaixb4g3fm delete: tags: - Activity summary: TaskSharingSalesUnitRelations.delete operationId: Activity_removeById description: Removes TaskSharingSalesUnitRelation with given id parameters: - description: ID of TaskSharingSalesUnitRelation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response11' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gdb5k34uesa16 patch: tags: - Activity summary: TaskSharingSalesUnitRelations.update operationId: Activity_updateTaskSharingSalesUnitRelation description: >- Modifies TaskSharingSalesUnitRelation or TaskSharingSalesUnitRelations with given id(s) parameters: - description: ID of TaskSharingSalesUnitRelation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskSharingSalesUnitRelationInput' responses: '200': description: >- Modification confirmation. Returns resulting TaskSharingSalesUnitRelation content: application/json: schema: $ref: >- #/components/schemas/ActivityUpdateTaskSharingSalesUnitRelationResponse '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: uso97d21quyzd /entities/TaskSharingSalesUnitRelations: get: tags: - Activity summary: TaskSharingSalesUnitRelations.list operationId: Activity_listTaskSharingSalesUnitRelations description: Returns all defined TaskSharingSalesUnitRelations parameters: - description: >- if enabled, deleted TaskSharingSalesUnitRelations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TaskSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/ActivityListTaskSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: am2b4ghv9kwro post: tags: - Activity summary: TaskSharingSalesUnitRelations.create operationId: Activity_createTaskSharingSalesUnitRelation description: Creates new TaskSharingSalesUnitRelation parameters: - description: >- Specify validation level of TaskSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TaskSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createTaskSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created TaskSharingSalesUnitRelation content: application/json: schema: $ref: >- #/components/schemas/ActivityCreateTaskSharingSalesUnitRelationResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: iuf8ehd78z7lb /entities/TaskSharingSalesUnitRelations/batch-delete: post: tags: - Activity summary: TaskSharingSalesUnitRelations.batch_delete operationId: Activity_removeBatchTaskSharingSalesUnitRelations description: Removes TaskSharingSalesUnitRelations with given list of ids parameters: - description: >- Specify validation level of TaskSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: >- #/components/schemas/ActivityRemoveBatchTaskSharingSalesUnitRelationsRequest responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: >- #/components/schemas/ActivityRemoveBatchTaskSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8fvowdwphr2c3 /entities/TaskSharingSalesUnitRelations/batch-modify: post: tags: - Activity summary: TaskSharingSalesUnitRelations.batch_create_or_update operationId: Activity_batchCreateOrUpdateTaskSharingSalesUnitRelations description: Create or update an batch of TaskSharingSalesUnitRelations parameters: - description: >- Specify validation level of TaskSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TaskSharingSalesUnitRelation required: true content: application / json: schema: $ref: >- #/components/schemas/ActivityBatchCreateOrUpdateTaskSharingSalesUnitRelationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated TaskSharingSalesUnitRelations content: application/json: schema: $ref: >- #/components/schemas/ActivityBatchCreateOrUpdateTaskSharingSalesUnitRelationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f9tmeloi8p48x /entities/TaskTypes/{id}: get: tags: - Activity summary: TaskTypes.get operationId: Activity_getTaskType description: Returns TaskType with given id parameters: - description: ID of TaskType to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TaskType data content: application/json: schema: $ref: '#/components/schemas/ActivityGetTaskTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: csb2yxsxs8dho delete: tags: - Activity summary: TaskTypes.delete operationId: Activity_removeById description: Removes TaskType with given id parameters: - description: ID of TaskType to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveById200Response12' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: o5objp2idfnxg patch: tags: - Activity summary: TaskTypes.update operationId: Activity_modifyTaskType description: Modifies TaskType or TaskTypes with given id(s) parameters: - description: ID of TaskType to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TaskType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTaskTypeInput' responses: '200': description: Modification confirmation. Returns resulting TaskType content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskTypeResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 72mvmsxg5i77s /entities/TaskTypes: get: tags: - Activity summary: TaskTypes.list operationId: Activity_getAllTaskTypes description: Returns all defined TaskTypes parameters: - description: if enabled, deleted TaskTypes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TaskTypes content: application/json: schema: $ref: '#/components/schemas/ActivityGetAllTaskTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: g8s0tg2pnryqw post: tags: - Activity summary: TaskTypes.create operationId: Activity_createTaskType description: Creates new TaskType parameters: - description: >- Specify validation level of TaskType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TaskType required: true content: application / json: schema: $ref: '#/components/schemas/createTaskTypeInput' responses: '201': description: Creation confirmation. Returns created TaskType content: application/json: schema: $ref: '#/components/schemas/ActivityCreateTaskTypeResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 37gpl3f9iirbx /entities/TaskTypes/batch-delete: post: tags: - Activity summary: TaskTypes.batch_delete operationId: Activity_removeBatchTaskTypes description: Removes TaskTypes with given list of ids parameters: - description: >- Specify validation level of TaskTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/ActivityRemoveBatchTaskTypesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/ActivityRemoveBatchTaskTypesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6lfsnrwcj2nyj /entities/TaskTypes/batch-modify: post: tags: - Activity summary: TaskTypes.batch_create_or_update operationId: Activity_modifyTaskTypesBatch description: Create or update an batch of TaskTypes parameters: - description: >- Specify validation level of TaskTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TaskTypes. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TaskType required: true content: application / json: schema: $ref: '#/components/schemas/ActivityModifyTaskTypesBatchRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated TaskTypes content: application/json: schema: $ref: '#/components/schemas/ActivityModifyTaskTypesBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wj3j40oo9sh11 /entities/TextMessages/{id}: get: tags: - Text summary: TextMessages.get operationId: Text_getById description: Returns TextMessage with given id parameters: - description: ID of TextMessage to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TextMessage data content: application/json: schema: $ref: '#/components/schemas/TextGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9jkwp00m2l267 delete: tags: - Text summary: TextMessages.delete operationId: Text_removeById description: Removes TextMessage with given id parameters: - description: ID of TextMessage to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessage 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: smd0545f5k6h0 patch: tags: - Text summary: TextMessages.update operationId: Text_modifyById description: Modifies TextMessage or TextMessages with given id(s) parameters: - description: ID of TextMessage to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessage 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTextMessageInput' responses: '200': description: Modification confirmation. Returns resulting TextMessage content: application/json: schema: $ref: '#/components/schemas/TextModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 96w340sm0ibpf /entities/TextMessages: get: tags: - Text summary: TextMessages.list operationId: Text_getAllTextMessages description: Returns all defined TextMessages parameters: - description: if enabled, deleted TextMessages are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TextMessages content: application/json: schema: $ref: '#/components/schemas/TextGetAllTextMessagesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: leptgmiv9s4g4 post: tags: - Text summary: TextMessages.create operationId: Text_createNewTextMessage description: Creates new TextMessage parameters: - description: >- Specify validation level of TextMessage 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TextMessage required: true content: application / json: schema: $ref: '#/components/schemas/createTextMessageInput' responses: '201': description: Creation confirmation. Returns created TextMessage content: application/json: schema: $ref: '#/components/schemas/TextCreateNewTextMessageResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 8mxyzbh284ekv /entities/TextMessages/batch-delete: post: tags: - Text summary: TextMessages.batch_delete operationId: Text_removeBatch description: Removes TextMessages with given list of ids parameters: - description: >- Specify validation level of TextMessages 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessages. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TextRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2tpd7zm5nu5tw /entities/TextMessages/batch-modify: post: tags: - Text summary: TextMessages.batch_create_or_update operationId: Text_modifyBatchTextMessages description: Create or update an batch of TextMessages parameters: - description: >- Specify validation level of TextMessages 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessages. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TextMessage required: true content: application / json: schema: $ref: '#/components/schemas/TextModifyBatchTextMessagesRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TextMessages content: application/json: schema: $ref: '#/components/schemas/TextModifyBatchTextMessagesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: m3mtmhxjsnzrg /entities/TextMessageConversations/{id}: get: tags: - Text summary: TextMessageConversations.get operationId: Text_getById description: Returns TextMessageConversation with given id parameters: - description: ID of TextMessageConversation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TextMessageConversation data content: application/json: schema: $ref: '#/components/schemas/TextGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ht8sodkc8r1sv delete: tags: - Text summary: TextMessageConversations.delete operationId: Text_removeById description: Removes TextMessageConversation with given id parameters: - description: ID of TextMessageConversation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessageConversation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: tfzehqe9ft6sr patch: tags: - Text summary: TextMessageConversations.update operationId: Text_modifyConversation description: >- Modifies TextMessageConversation or TextMessageConversations with given id(s) parameters: - description: ID of TextMessageConversation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessageConversation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTextMessageConversationInput' responses: '200': description: Modification confirmation. Returns resulting TextMessageConversation content: application/json: schema: $ref: '#/components/schemas/TextModifyConversationResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ukf2y0x2ylysu /entities/TextMessageConversations: get: tags: - Text summary: TextMessageConversations.list operationId: Text_getAll description: Returns all defined TextMessageConversations parameters: - description: if enabled, deleted TextMessageConversations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TextMessageConversations content: application/json: schema: $ref: '#/components/schemas/TextGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6mtxbvoinbm6o post: tags: - Text summary: TextMessageConversations.create operationId: Text_createConversation description: Creates new TextMessageConversation parameters: - description: >- Specify validation level of TextMessageConversation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TextMessageConversation required: true content: application / json: schema: $ref: '#/components/schemas/createTextMessageConversationInput' responses: '201': description: Creation confirmation. Returns created TextMessageConversation content: application/json: schema: $ref: '#/components/schemas/TextCreateConversationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 6dvrkaij35xpl /entities/TextMessageConversations/batch-delete: post: tags: - Text summary: TextMessageConversations.batch_delete operationId: Text_removeBatch description: Removes TextMessageConversations with given list of ids parameters: - description: >- Specify validation level of TextMessageConversations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessageConversations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TextRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: oqr4q23zzldf1 /entities/TextMessageConversations/batch-modify: post: tags: - Text summary: TextMessageConversations.batch_create_or_update operationId: Text_createOrUpdateBatchTextMessageConversations description: Create or update an batch of TextMessageConversations parameters: - description: >- Specify validation level of TextMessageConversations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessageConversations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TextMessageConversation required: true content: application / json: schema: $ref: >- #/components/schemas/TextCreateOrUpdateBatchTextMessageConversationsRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated TextMessageConversations content: application/json: schema: $ref: >- #/components/schemas/TextCreateOrUpdateBatchTextMessageConversationsResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: gtqwjqn4c2na1 /entities/TextMessageConversationRelationses/{id}: get: tags: - Text summary: TextMessageConversationRelationses.get operationId: Text_getById description: Returns TextMessageConversationRelations with given id parameters: - description: ID of TextMessageConversationRelations to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: TextMessageConversationRelations data content: application/json: schema: $ref: '#/components/schemas/TextGetById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qn0462wihcwzu delete: tags: - Text summary: TextMessageConversationRelationses.delete operationId: Text_removeById description: Removes TextMessageConversationRelations with given id parameters: - description: ID of TextMessageConversationRelations to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessageConversationRelations 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveById200Response1' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 9ob9hri9hlv37 patch: tags: - Text summary: TextMessageConversationRelationses.update operationId: Text_updateById description: >- Modifies TextMessageConversationRelations or TextMessageConversationRelationses with given id(s) parameters: - description: ID of TextMessageConversationRelations to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of TextMessageConversationRelations 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTextMessageConversationRelationsInput' responses: '200': description: >- Modification confirmation. Returns resulting TextMessageConversationRelations content: application/json: schema: $ref: '#/components/schemas/TextUpdateByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: swz9zwwxrm05f /entities/TextMessageConversationRelationses: get: tags: - Text summary: TextMessageConversationRelationses.list operationId: Text_listTextMessageConversationRelationses description: Returns all defined TextMessageConversationRelationses parameters: - description: >- if enabled, deleted TextMessageConversationRelationses are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of TextMessageConversationRelationses content: application/json: schema: $ref: >- #/components/schemas/TextListTextMessageConversationRelationsesResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: k6p8pcjouae4r post: tags: - Text summary: TextMessageConversationRelationses.create operationId: Text_createRelations description: Creates new TextMessageConversationRelations parameters: - description: >- Specify validation level of TextMessageConversationRelations 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new TextMessageConversationRelations required: true content: application / json: schema: $ref: '#/components/schemas/createTextMessageConversationRelationsInput' responses: '201': description: >- Creation confirmation. Returns created TextMessageConversationRelations content: application/json: schema: $ref: '#/components/schemas/TextCreateRelationsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: nniy8z4ge8mm8 /entities/TextMessageConversationRelationses/batch-delete: post: tags: - Text summary: TextMessageConversationRelationses.batch_delete operationId: Text_removeByIds description: Removes TextMessageConversationRelationses with given list of ids parameters: - description: >- Specify validation level of TextMessageConversationRelationses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessageConversationRelationses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TextRemoveByIdsRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TextRemoveByIdsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3ct4xjq2regl3 /entities/TextMessageConversationRelationses/batch-modify: post: tags: - Text summary: TextMessageConversationRelationses.batch_create_or_update operationId: Text_batchCreateOrUpdate description: Create or update an batch of TextMessageConversationRelationses parameters: - description: >- Specify validation level of TextMessageConversationRelationses 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for TextMessageConversationRelationses. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new TextMessageConversationRelations required: true content: application / json: schema: $ref: '#/components/schemas/TextBatchCreateOrUpdateRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated TextMessageConversationRelationses content: application/json: schema: $ref: '#/components/schemas/TextBatchCreateOrUpdateResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: w8pzjeqxk4g9b /entities/Timeframes/{id}: get: tags: - Timeframe summary: Timeframes.get operationId: Timeframe_getById description: Returns Timeframe with given id parameters: - description: ID of Timeframe to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Timeframe data content: application/json: schema: $ref: '#/components/schemas/TimeframeGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e2bgye2rhq16p /entities/Timeframes: get: tags: - Timeframe summary: Timeframes.list operationId: Timeframe_listAllDefined description: Returns all defined Timeframes parameters: - description: if enabled, deleted Timeframes are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Timeframes content: application/json: schema: $ref: '#/components/schemas/TimeframeListAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: u02ukrn9fkemj /entities/Translations/{id}: get: tags: - Translation summary: Translations.get operationId: Translation_getById description: Returns Translation with given id parameters: - description: ID of Translation to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Translation data content: application/json: schema: $ref: '#/components/schemas/TranslationGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: s51ivurqeo7ye delete: tags: - Translation summary: Translations.delete operationId: Translation_removeById description: Removes Translation with given id parameters: - description: ID of Translation to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Translation 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/TranslationRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ieqrbrzozhsqk patch: tags: - Translation summary: Translations.update operationId: Translation_modifyById description: Modifies Translation or Translations with given id(s) parameters: - description: ID of Translation to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Translation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateTranslationInput' responses: '200': description: Modification confirmation. Returns resulting Translation content: application/json: schema: $ref: '#/components/schemas/TranslationModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: qxjtsac5b218a /entities/Translations: get: tags: - Translation summary: Translations.list operationId: Translation_getAll description: Returns all defined Translations parameters: - description: if enabled, deleted Translations are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Translations content: application/json: schema: $ref: '#/components/schemas/TranslationGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e37y0rjafeadn post: tags: - Translation summary: Translations.create operationId: Translation_createNewTranslation description: Creates new Translation parameters: - description: >- Specify validation level of Translation 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Translation required: true content: application / json: schema: $ref: '#/components/schemas/createTranslationInput' responses: '201': description: Creation confirmation. Returns created Translation content: application/json: schema: $ref: '#/components/schemas/TranslationCreateNewTranslationResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 3bavarzihy1iz /entities/Translations/batch-delete: post: tags: - Translation summary: Translations.batch_delete operationId: Translation_removeById description: Removes Translations with given list of ids parameters: - description: >- Specify validation level of Translations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Translations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/TranslationRemoveByIdRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/TranslationRemoveById200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xnsi391ez6hjf /entities/Translations/batch-modify: post: tags: - Translation summary: Translations.batch_create_or_update operationId: Translation_batchModify description: Create or update an batch of Translations parameters: - description: >- Specify validation level of Translations 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Translations. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Translation required: true content: application / json: schema: $ref: '#/components/schemas/TranslationBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated Translations content: application/json: schema: $ref: '#/components/schemas/TranslationBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: xudocr4aq6rjg /entities/Types/{id}: get: tags: - Type summary: Types.get operationId: Type_getById description: Returns Type with given id parameters: - description: ID of Type to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Type data content: application/json: schema: $ref: '#/components/schemas/TypeGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: lnd2g7hhobjnk /entities/Types: get: tags: - Type summary: Types.list operationId: Type_getAllDefined description: Returns all defined Types parameters: - description: if enabled, deleted Types are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Types content: application/json: schema: $ref: '#/components/schemas/TypeGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4wjjly31rreaf /entities/UnsubscribedPhones/{id}: get: tags: - Unsubscribed summary: UnsubscribedPhones.get operationId: Unsubscribed_getById description: Returns UnsubscribedPhone with given id parameters: - description: ID of UnsubscribedPhone to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: UnsubscribedPhone data content: application/json: schema: $ref: '#/components/schemas/UnsubscribedGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: mio60ybdbyrsk delete: tags: - Unsubscribed summary: UnsubscribedPhones.delete operationId: Unsubscribed_removeById description: Removes UnsubscribedPhone with given id parameters: - description: ID of UnsubscribedPhone to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of UnsubscribedPhone 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/UnsubscribedRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d8upd3g3cxvco patch: tags: - Unsubscribed summary: UnsubscribedPhones.update operationId: Unsubscribed_updatePhone description: Modifies UnsubscribedPhone or UnsubscribedPhones with given id(s) parameters: - description: ID of UnsubscribedPhone to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of UnsubscribedPhone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateUnsubscribedPhoneInput' responses: '200': description: Modification confirmation. Returns resulting UnsubscribedPhone content: application/json: schema: $ref: '#/components/schemas/UnsubscribedUpdatePhoneResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4gryyse8vqvl0 /entities/UnsubscribedPhones: get: tags: - Unsubscribed summary: UnsubscribedPhones.list operationId: Unsubscribed_getAllPhones description: Returns all defined UnsubscribedPhones parameters: - description: if enabled, deleted UnsubscribedPhones are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of UnsubscribedPhones content: application/json: schema: $ref: '#/components/schemas/UnsubscribedGetAllPhonesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wulnwoo09328t post: tags: - Unsubscribed summary: UnsubscribedPhones.create operationId: Unsubscribed_registerNewPhone description: Creates new UnsubscribedPhone parameters: - description: >- Specify validation level of UnsubscribedPhone 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new UnsubscribedPhone required: true content: application / json: schema: $ref: '#/components/schemas/createUnsubscribedPhoneInput' responses: '201': description: Creation confirmation. Returns created UnsubscribedPhone content: application/json: schema: $ref: '#/components/schemas/UnsubscribedRegisterNewPhoneResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: v7t5od6t373qm /entities/UnsubscribedPhones/batch-delete: post: tags: - Unsubscribed summary: UnsubscribedPhones.batch_delete operationId: Unsubscribed_removeBatchPhones description: Removes UnsubscribedPhones with given list of ids parameters: - description: >- Specify validation level of UnsubscribedPhones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for UnsubscribedPhones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/UnsubscribedRemoveBatchPhonesRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/UnsubscribedRemoveBatchPhonesResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: wqbmy1h1hizpy /entities/UnsubscribedPhones/batch-modify: post: tags: - Unsubscribed summary: UnsubscribedPhones.batch_create_or_update operationId: Unsubscribed_processBatchCreateOrUpdate description: Create or update an batch of UnsubscribedPhones parameters: - description: >- Specify validation level of UnsubscribedPhones 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for UnsubscribedPhones. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new UnsubscribedPhone required: true content: application / json: schema: $ref: >- #/components/schemas/UnsubscribedProcessBatchCreateOrUpdateRequest responses: '200': description: >- Creation confirmation. Returns a list of created / updated UnsubscribedPhones content: application/json: schema: $ref: >- #/components/schemas/UnsubscribedProcessBatchCreateOrUpdateResponse '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 4ks48ekxmui1a /entities/Webhooks/{id}: get: tags: - Webhook summary: Webhooks.get operationId: Webhook_getById description: Returns Webhook with given id parameters: - description: ID of Webhook to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Webhook data content: application/json: schema: $ref: '#/components/schemas/WebhookGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: f5ziix86evqzw delete: tags: - Webhook summary: Webhooks.delete operationId: Webhook_removeById description: Removes Webhook with given id parameters: - description: ID of Webhook to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Webhook 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebhookRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: dkxfxoiyvhgu7 patch: tags: - Webhook summary: Webhooks.update operationId: Webhook_modifyById description: Modifies Webhook or Webhooks with given id(s) parameters: - description: ID of Webhook to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Webhook 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateWebhookInput' responses: '200': description: Modification confirmation. Returns resulting Webhook content: application/json: schema: $ref: '#/components/schemas/WebhookModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: adcwqhocp4iwo /entities/Webhooks: get: tags: - Webhook summary: Webhooks.list operationId: Webhook_getAllDefined description: Returns all defined Webhooks parameters: - description: if enabled, deleted Webhooks are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Webhooks content: application/json: schema: $ref: '#/components/schemas/WebhookGetAllDefinedResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vo577rzxc33wi post: tags: - Webhook summary: Webhooks.create operationId: Webhook_createNew description: Creates new Webhook parameters: - description: >- Specify validation level of Webhook 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Webhook required: true content: application / json: schema: $ref: '#/components/schemas/createWebhookInput' responses: '201': description: Creation confirmation. Returns created Webhook content: application/json: schema: $ref: '#/components/schemas/WebhookCreateNewResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jje0tt8oy0da1 /entities/Webhooks/batch-delete: post: tags: - Webhook summary: Webhooks.batch_delete operationId: Webhook_removeBatch description: Removes Webhooks with given list of ids parameters: - description: >- Specify validation level of Webhooks 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Webhooks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/WebhookRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebhookRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 2uznao3m209dq /entities/Webhooks/batch-modify: post: tags: - Webhook summary: Webhooks.batch_create_or_update operationId: Webhook_batchModify description: Create or update an batch of Webhooks parameters: - description: >- Specify validation level of Webhooks 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Webhooks. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Webhook required: true content: application / json: schema: $ref: '#/components/schemas/WebhookBatchModifyRequest' responses: '200': description: Creation confirmation. Returns a list of created / updated Webhooks content: application/json: schema: $ref: '#/components/schemas/WebhookBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: vrymoss2dn4va /entities/WebhookEvents/{id}: get: tags: - Webhook summary: WebhookEvents.get operationId: Webhook_getById description: Returns WebhookEvent with given id parameters: - description: ID of WebhookEvent to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: WebhookEvent data content: application/json: schema: $ref: '#/components/schemas/WebhookGetById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: jj0x4ei95luad delete: tags: - Webhook summary: WebhookEvents.delete operationId: Webhook_removeById description: Removes WebhookEvent with given id parameters: - description: ID of WebhookEvent to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of WebhookEvent 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebhookRemoveById200Response' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: omoai13mecgwe patch: tags: - Webhook summary: WebhookEvents.update operationId: Webhook_modifyEvent description: Modifies WebhookEvent or WebhookEvents with given id(s) parameters: - description: ID of WebhookEvent to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of WebhookEvent 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateWebhookEventInput' responses: '200': description: Modification confirmation. Returns resulting WebhookEvent content: application/json: schema: $ref: '#/components/schemas/WebhookModifyEventResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: sfh0fgnp76ibf /entities/WebhookEvents: get: tags: - Webhook summary: WebhookEvents.list operationId: Webhook_getAllEvents description: Returns all defined WebhookEvents parameters: - description: if enabled, deleted WebhookEvents are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of WebhookEvents content: application/json: schema: $ref: '#/components/schemas/WebhookGetAllEventsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ctp0w0i8wrh0e post: tags: - Webhook summary: WebhookEvents.create operationId: Webhook_createNewEvent description: Creates new WebhookEvent parameters: - description: >- Specify validation level of WebhookEvent 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new WebhookEvent required: true content: application / json: schema: $ref: '#/components/schemas/createWebhookEventInput' responses: '201': description: Creation confirmation. Returns created WebhookEvent content: application/json: schema: $ref: '#/components/schemas/WebhookCreateNewEventResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: y8ssjx11vnf4e /entities/WebhookEvents/batch-delete: post: tags: - Webhook summary: WebhookEvents.batch_delete operationId: Webhook_removeBatch description: Removes WebhookEvents with given list of ids parameters: - description: >- Specify validation level of WebhookEvents 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/WebhookRemoveBatchRequest1' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebhookRemoveBatch200Response' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 26x1vcu0xxrqu /entities/WebhookEvents/batch-modify: post: tags: - Webhook summary: WebhookEvents.batch_create_or_update operationId: Webhook_batchModifyEvents description: Create or update an batch of WebhookEvents parameters: - description: >- Specify validation level of WebhookEvents 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new WebhookEvent required: true content: application / json: schema: $ref: '#/components/schemas/WebhookBatchModifyEventsRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated WebhookEvents content: application/json: schema: $ref: '#/components/schemas/WebhookBatchModifyEventsResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 07x04q3yomas7 /entities/Webresources/{id}: get: tags: - Webresource summary: Webresources.get operationId: Webresource_getById description: Returns Webresource with given id parameters: - description: ID of Webresource to retrieve name: id in: path required: true schema: type: string format: uuid responses: '200': description: Webresource data content: application/json: schema: $ref: '#/components/schemas/WebresourceGetByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: fgfrzyv6z22dx delete: tags: - Webresource summary: Webresources.delete operationId: Webresource_removeById description: Removes Webresource with given id parameters: - description: ID of Webresource to delete name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Webresource 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. name: validation-level in: query schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebresourceRemoveByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: e6k00e0of1bsk patch: tags: - Webresource summary: Webresources.update operationId: Webresource_modifyById description: Modifies Webresource or Webresources with given id(s) parameters: - description: ID of Webresource to update name: id in: path required: true schema: type: string format: uuid - description: >- Specify validation level of Webresource 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateWebresourceInput' responses: '200': description: Modification confirmation. Returns resulting Webresource content: application/json: schema: $ref: '#/components/schemas/WebresourceModifyByIdResponse' '404': description: Sent when invalid ID is given content: application / json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: encag605pl5oj /entities/Webresources: get: tags: - Webresource summary: Webresources.list operationId: Webresource_getAll description: Returns all defined Webresources parameters: - description: if enabled, deleted Webresources are returned as well name: include-deleted in: query required: false schema: type: boolean - description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 name: first in: query required: false schema: type: integer format: int32 - 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. name: last in: query required: false schema: type: integer format: int32 - description: Cursor until which to take entities to result set. name: before in: query required: false schema: type: string - description: Cursor after which to start taking entities to result set. name: after in: query required: false schema: type: string - 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. name: expand in: query required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - 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. name: order-by in: query example: order-by=created,-modified required: false schema: type: string - description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. name: filter in: query example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - 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]. name: filter-op in: query example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - 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. name: load-only in: query required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Webresources content: application/json: schema: $ref: '#/components/schemas/WebresourceGetAllResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: napewcroov8fh post: tags: - Webresource summary: Webresources.create operationId: Webresource_createNewWebresource description: Creates new Webresource parameters: - description: >- Specify validation level of Webresource 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. name: validation-level in: query schema: type: integer format: int32 requestBody: description: data of new Webresource required: true content: application / json: schema: $ref: '#/components/schemas/createWebresourceInput' responses: '201': description: Creation confirmation. Returns created Webresource content: application/json: schema: $ref: '#/components/schemas/WebresourceCreateNewWebresourceResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: d5rck21ccz3kh /entities/Webresources/batch-delete: post: tags: - Webresource summary: Webresources.batch_delete operationId: Webresource_removeBatch description: Removes Webresources with given list of ids parameters: - description: >- Specify validation level of Webresources 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Webresources. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: $ref: '#/components/schemas/WebresourceRemoveBatchRequest' responses: '200': description: Batch removal confirmation content: application/json: schema: $ref: '#/components/schemas/WebresourceRemoveBatchResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: 92186kyk4v9p9 /entities/Webresources/batch-modify: post: tags: - Webresource summary: Webresources.batch_create_or_update operationId: Webresource_batchModify description: Create or update an batch of Webresources parameters: - description: >- Specify validation level of Webresources 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. name: validation-level in: query schema: type: integer format: int32 - description: >- Specify rollback method for Webresources. 0 - rollback all, 1 - rollback only failed records. name: rollback-method in: query schema: type: integer format: int32 requestBody: description: data of new Webresource required: true content: application / json: schema: $ref: '#/components/schemas/WebresourceBatchModifyRequest' responses: '200': description: >- Creation confirmation. Returns a list of created / updated Webresources content: application/json: schema: $ref: '#/components/schemas/WebresourceBatchModifyResponse' '500': description: unexpected error content: application / json: schema: $ref: '#/components/schemas/Error' x-stoplight: id: ovb8g6bn8ay0e components: schemas: Error: properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status x-stoplight: id: 9lrchaxbt82o4 Account: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties. type: string format: uri is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' account_type: description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. type: string format: uri customer_type: description: >- 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. type: string format: uri industry: description: >- 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. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri parent_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri parent_account_relation_type: description: >- Relation to ParentAccountRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ParentAccountRelationType' object for properties. type: string format: uri picture: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri account_class: description: >- Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string customer_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string health_category: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 health_status: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 home_page: description: URL - HTTP address. type: string example: string industry_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_parent_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 formatted_name: description: '' type: string example: string social_media: description: >- Relation to AccountSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSocialRelation' object for properties. type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to AccountSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to AccountSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSharingClientRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri is_favorite: description: '' type: boolean example: false is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false health: description: '' type: object modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - account_type - owner - unit - name - owner_id - formatted_name - is_favorite x-stoplight: id: 5s4kjc4siwxfk createAccountInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'createTagRelationInput' object for properties. type: object properties: id: type: string format: uri modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri account_class: description: >- Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string customer_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string home_page: description: URL - HTTP address. type: string example: string industry_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_parent_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to AccountSocialRelation, see: 'createAccountSocialRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to AccountSharingSalesUnitRelation, see: 'createAccountSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to AccountSharingClientRelation, see: 'createAccountSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false required: - name - owner_id x-stoplight: id: ztbenzl6klbq5 updateAccountInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri account_class: description: >- Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string customer_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string home_page: description: URL - HTTP address. type: string example: string industry_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_parent_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to AccountSocialRelation, see: 'updateAccountSocialRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to AccountSharingSalesUnitRelation, see: 'updateAccountSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to AccountSharingClientRelation, see: 'updateAccountSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false x-stoplight: id: fpteowksj2jjk batchAccountInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri account_class: description: >- Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string customer_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string home_page: description: URL - HTTP address. type: string example: string industry_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_parent_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to AccountSocialRelation, see: 'updateAccountSocialRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to AccountSharingSalesUnitRelation, see: 'updateAccountSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to AccountSharingClientRelation, see: 'updateAccountSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false id: description: ID of object to update. type: string format: uuid x-stoplight: id: aun0ht9onur6h AccountDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri data: description: >- 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. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - data - account_id - data_id - data_set_id x-stoplight: id: 54jnl278m53cb AccountKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - owner - account_id - kpi - owner_id x-stoplight: id: vsyu297luodkh createAccountKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_id - kpi - owner_id x-stoplight: id: 43aypbda8dsfj updateAccountKPIInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: zh43ohr6v0lbq batchAccountKPIInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: fgb36g3gnal29 AccountRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account1: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri account2: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri account1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account1 - account2 - account1_id - account2_id x-stoplight: id: yokgyxdapo57i createAccountRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account1_id - account2_id x-stoplight: id: rdeoobsi2cwdb updateAccountRelationInput: properties: account1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: i9js1y04aewuw batchAccountRelationInput: properties: account1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 0quw32z04jxun AccountRelationLabel: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_relation: description: >- Relation to AccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRelation' object for properties. type: string format: uri account_relation_type: description: >- Relation to AccountRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRelationType' object for properties. type: string format: uri account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account_relation - account_relation_type - account_relation_id - account_relation_type_id x-stoplight: id: r4o1pxxbcd939 createAccountRelationLabelInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_relation: description: >- Relation to AccountRelation, see: 'createAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_relation - account_relation_id - account_relation_type_id x-stoplight: id: v8ekyim5z9cha updateAccountRelationLabelInput: properties: account_relation: description: >- Relation to AccountRelation, see: 'updateAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: gwtgt71bl0ifw batchAccountRelationLabelInput: properties: account_relation: description: >- Relation to AccountRelation, see: 'updateAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ltezoawkm0s3a AccountRelationType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color x-stoplight: id: 9ul3003wfm1lw createAccountRelationTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color x-stoplight: id: wdhfybp0zeejq updateAccountRelationTypeInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: crq53pf0wyu83 batchAccountRelationTypeInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: wlf46q0jhjxum AccountRole: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color - label x-stoplight: id: kg0rjbrfqiswx createAccountRoleInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color - label x-stoplight: id: ewwl862rrhj4m updateAccountRoleInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 3fevhhc1fi71x batchAccountRoleInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 1k6y38i94el18 AccountSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - client - account_id - client_id x-stoplight: id: 2yush28ijqmef createAccountSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_id - client_id x-stoplight: id: on4d4iyj8rbl6 updateAccountSharingClientRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: ou9mne7ao2bsw batchAccountSharingClientRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: e8rj11ytmx7uf AccountSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - unit - account_id - unit_id x-stoplight: id: fn79q4oasr1wz createAccountSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_id - unit_id x-stoplight: id: z4gu2odrcd6oe updateAccountSharingSalesUnitRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 1lfcb6kyy8jjn batchAccountSharingSalesUnitRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 3ckfwmjofh54u AccountSocialRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. Must match with Account id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id x-stoplight: id: 1zixzdof4ejhl createAccountSocialRelationInput: properties: id: description: Unique identifier of entity. Must match with Account id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - id x-stoplight: id: w68uvjc7o9yme updateAccountSocialRelationInput: properties: angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: r177aonvei2tb batchAccountSocialRelationInput: properties: angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: wub7yholauv2q AccountType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name x-stoplight: id: ij1xu2h9nex7t createAccountTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: yvx3mivu98wrl updateAccountTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 69lt562xe3itm batchAccountTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: m2aag68fy7b2p Activity: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true active_reminder: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id x-stoplight: id: 85cirohrl3kd6 ActivityComment: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - activity_id - comment - owner_id x-stoplight: id: 0w6you0rwi4cf createActivityCommentInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - activity_id - comment - owner_id x-stoplight: id: mb1mkevtgewdi updateActivityCommentInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 4vkrnyywoakj7 batchActivityCommentInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 85ri1mqhrvnjr ActivityDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri data: description: >- 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. type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - activity_id - data_id - data_set_id x-stoplight: id: hgvty2qupr7mr ActivityKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted' type: integer example: 1 enum: - 1 - 2 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - unit - activity_id - kpi - unit_id x-stoplight: id: zjhf78d6o8b1y createActivityKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted' type: integer example: 1 enum: - 1 - 2 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - activity_id - kpi - unit_id x-stoplight: id: d8gbnpoz7qoi9 updateActivityKPIInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted' type: integer example: 1 enum: - 1 - 2 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: c67fxskqmbvy5 batchActivityKPIInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted' type: integer example: 1 enum: - 1 - 2 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: v85uffho5tqkd ActivityRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri project_objective: description: >- Relation to ProjectObjective. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectObjective' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_objective_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - activity_id x-stoplight: id: 16yp52b19bj1z createActivityRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true project_objective: description: >- Relation to ProjectObjective, see: 'createProjectObjectiveInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_objective_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - activity_id x-stoplight: id: wu8pahh0wuy82 updateActivityRelationInput: properties: project_objective: description: >- Relation to ProjectObjective, see: 'updateProjectObjectiveInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_objective_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 6jm4a1d1iliza batchActivityRelationInput: properties: project_objective: description: >- Relation to ProjectObjective, see: 'updateProjectObjectiveInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_objective_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: yk1hbzy5rsp8n AllowedAccountType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type: description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account_type - master_right - account_type_id - master_right_id x-stoplight: id: 6xnnfablzt9yt createAllowedAccountTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_type_id - master_right_id x-stoplight: id: z16tp9hi97i4l updateAllowedAccountTypeInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: snm5vzoma01sc batchAllowedAccountTypeInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 10pm58vb1e94r AllowedCompanyEmail: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true company_email: description: >- Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - company_email - master_right - company_email_id - master_right_id x-stoplight: id: 2qpob1rjs1td3 createAllowedCompanyEmailInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - company_email_id - master_right_id x-stoplight: id: 7r9zn2mv4xwi2 updateAllowedCompanyEmailInput: properties: company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: fnqzr16ps36kn batchAllowedCompanyEmailInput: properties: company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: sm1yp4dlt7tey AllowedCompanyPhone: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri phone: description: >- Relation to Phone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Phone' object for properties. type: string format: uri master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - master_right - phone - master_right_id - phone_id x-stoplight: id: ntispch0hh5da createAllowedCompanyPhoneInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - master_right_id - phone_id x-stoplight: id: 7qwdmj7lcw9t4 updateAllowedCompanyPhoneInput: properties: master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: cs4vr96p00711 batchAllowedCompanyPhoneInput: properties: master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: fxm27a0aaafhs AllowedContactType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_type: description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact_type - master_right - contact_type_id - master_right_id x-stoplight: id: 25zo0t7sxtiru createAllowedContactTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_type_id - master_right_id x-stoplight: id: qyuxqagdhpk7m updateAllowedContactTypeInput: properties: contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: mzjg0b4xtd6ua batchAllowedContactTypeInput: properties: contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: zdiczqn3074g5 AllowedLeadType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - lead_type - master_right - lead_type_id - master_right_id x-stoplight: id: mvdhjrnnvhdvv createAllowedLeadTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - lead_type_id - master_right_id x-stoplight: id: olq2xgtyikryb updateAllowedLeadTypeInput: properties: lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: c6cw54rwzyca8 batchAllowedLeadTypeInput: properties: lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: uhofch3skjgyc AllowedPipeline: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri pipeline: description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. type: string format: uri access_step_documents: description: Boolean value. type: boolean example: false master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - master_right - pipeline - master_right_id - pipeline_id x-stoplight: id: r0yhu9b1j2st6 createAllowedPipelineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true access_step_documents: description: Boolean value. type: boolean example: false master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - master_right_id - pipeline_id x-stoplight: id: 072f49z1ylrly updateAllowedPipelineInput: properties: access_step_documents: description: Boolean value. type: boolean example: false master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: pvx5kjdlwjygs batchAllowedPipelineInput: properties: access_step_documents: description: Boolean value. type: boolean example: false master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 8qlgukwo2x1t2 AllowedQuoteType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri quote_type: description: >- Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. type: string format: uri master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - master_right - quote_type - master_right_id - quote_type_id x-stoplight: id: m9p7rpx4o9fp4 createAllowedQuoteTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - master_right_id - quote_type_id x-stoplight: id: 1g7oob4ep2w58 updateAllowedQuoteTypeInput: properties: master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: ko1tdj51ijg1h batchAllowedQuoteTypeInput: properties: master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ftvmpz857oyib ApiAccess: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. Must match with Application id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: Email address. type: string example: string is_active: description: Boolean value. type: boolean example: false last_used: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' permissions: description: Field containing json. type: object type: description: 'Integer enum value: 1 - Basic, 2 - OAuth' type: integer example: 1 enum: - 1 - 2 readOnly: true name: description: Name for the api access. type: string example: string username: description: '' type: string example: string plain_password: description: '' type: string example: string required: - is_delete_protected - id - type - name x-stoplight: id: nvma4xj6azkbr Appointment: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true active_reminder: description: '' type: string format: date-time example: '2019-01-01T00:00:00' is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_type: description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri recurrence_master: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri schedule: description: >- Relation to AppointmentSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentSchedule' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 end_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' invitees_can_edit: description: Boolean value. type: boolean example: false is_recurrence_active: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false is_recurrence_exception: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false location: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string meeting_url: description: Field containing json. type: object occurence_date: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: date-time example: '2019-01-01T00:00:00' organizer: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_master_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_rule: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string recurrence_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 schedule_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string start_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' subject: description: Name of the entity and its default text representation. type: string example: string table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 status: description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred, 6 - Canceled type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri invitees_contacts: description: Relations to AppointmentContactInviteesRelations. type: array items: description: >- Relation to AppointmentContactInviteesRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentContactInviteesRelation' object for properties. type: string format: uri invitees_clients: description: Relations to Clients. type: array items: description: >- Relation to AppointmentClientInviteesRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentClientInviteesRelation' object for properties. type: string format: uri has_3rd_party_mapping: description: '' type: boolean example: false reminder: description: >- Relation to AppointmentReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentReminder' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityComment' object for properties. type: string format: uri formatted_name: description: '' type: string example: string recurrence: description: '' type: object modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - activity_type - owner - unit - end_date - owner_id - subject - table_name - status - has_3rd_party_mapping - formatted_name x-stoplight: id: fhmflaqqqwsg0 createAppointmentInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 end_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' invitees_can_edit: description: Boolean value. type: boolean example: false is_recurrence_active: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false is_recurrence_exception: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false location: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string meeting_url: description: Field containing json. type: object occurence_date: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: date-time example: '2019-01-01T00:00:00' organizer: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_master_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_rule: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string recurrence_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 schedule_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string start_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_contacts: description: Relations to AppointmentContactInviteesRelations. type: array items: description: >- Relation to AppointmentContactInviteesRelation, see: 'createAppointmentContactInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_clients: description: Relations to Clients. type: array items: description: >- Relation to AppointmentClientInviteesRelation, see: 'createAppointmentClientInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri reminder: description: >- Relation to AppointmentReminder, see: 'createAppointmentReminderInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'createActivityCommentInput' object for properties. type: object properties: id: type: string format: uri required: - end_date - owner_id - subject x-stoplight: id: vnokywqa39pvk updateAppointmentInput: properties: description: description: Multi-line text input field. type: string example: string activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 end_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' invitees_can_edit: description: Boolean value. type: boolean example: false is_recurrence_active: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false is_recurrence_exception: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false location: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string meeting_url: description: Field containing json. type: object occurence_date: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: date-time example: '2019-01-01T00:00:00' organizer: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_master_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_rule: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string recurrence_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 schedule_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string start_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_contacts: description: Relations to AppointmentContactInviteesRelations. type: array items: description: >- Relation to AppointmentContactInviteesRelation, see: 'updateAppointmentContactInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_clients: description: Relations to Clients. type: array items: description: >- Relation to AppointmentClientInviteesRelation, see: 'updateAppointmentClientInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: qqssk1j855wi6 batchAppointmentInput: properties: description: description: Multi-line text input field. type: string example: string activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 end_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' invitees_can_edit: description: Boolean value. type: boolean example: false is_recurrence_active: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false is_recurrence_exception: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false location: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string meeting_url: description: Field containing json. type: object occurence_date: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: date-time example: '2019-01-01T00:00:00' organizer: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_master_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recurrence_rule: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string recurrence_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 schedule_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string start_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_contacts: description: Relations to AppointmentContactInviteesRelations. type: array items: description: >- Relation to AppointmentContactInviteesRelation, see: 'updateAppointmentContactInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri invitees_clients: description: Relations to Clients. type: array items: description: >- Relation to AppointmentClientInviteesRelation, see: 'updateAppointmentClientInviteesRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: liz7c5yl5rgxe AppointmentClientInviteesRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - appointment - client - appointment_id - client_id x-stoplight: id: w8v22taxzzs37 createAppointmentClientInviteesRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - appointment_id - client_id x-stoplight: id: o4s7z3u965b6y updateAppointmentClientInviteesRelationInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: q3sio4ddwulor batchAppointmentClientInviteesRelationInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: of1e9n6yhpgo4 AppointmentContactInviteesRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address. type: string example: string first_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string invitee_type: description: 'Integer enum value: 0 - Standard, 1 - Scheduled' type: integer example: 0 enum: - 0 - 1 last_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - appointment - appointment_id - email x-stoplight: id: y2lcnl0391tyh createAppointmentContactInviteesRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address. type: string example: string first_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string invitee_type: description: 'Integer enum value: 0 - Standard, 1 - Scheduled' type: integer example: 0 enum: - 0 - 1 last_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - appointment_id - email x-stoplight: id: x10o7evc7wsos updateAppointmentContactInviteesRelationInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address. type: string example: string first_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string invitee_type: description: 'Integer enum value: 0 - Standard, 1 - Scheduled' type: integer example: 0 enum: - 0 - 1 last_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 1ed8nyq606y8k batchAppointmentContactInviteesRelationInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address. type: string example: string first_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string invitee_type: description: 'Integer enum value: 0 - Standard, 1 - Scheduled' type: integer example: 0 enum: - 0 - 1 last_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string response: description: 'Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: pp9543xuvefga AppointmentReminder: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date_offset: description: Whole natural number. type: integer format: int32 example: 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 snooze_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - appointment - owner - appointment_id - end_date_offset - owner_id x-stoplight: id: td4wkhaht7mzi createAppointmentReminderInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date_offset: description: Whole natural number. type: integer format: int32 example: 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 snooze_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - appointment_id - end_date_offset - owner_id x-stoplight: id: kejenzjf7pzou updateAppointmentReminderInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date_offset: description: Whole natural number. type: integer format: int32 example: 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 snooze_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: iktjtw7do55mz batchAppointmentReminderInput: properties: appointment_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date_offset: description: Whole natural number. type: integer format: int32 example: 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 snooze_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: to4ar7nk5nllo AppointmentSchedule: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri appointment_type: description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri appointment_description: description: String value. type: string example: string appointment_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 appointment_location: description: String value. type: string example: string appointment_location_type: description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom' type: integer example: 0 enum: - 0 - 1 - 2 appointment_owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_subject: description: String value. type: string example: string appointment_subject_uses_schedule_name: description: Boolean value. type: boolean example: false appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 availability_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string buffer_time_after: description: Whole natural number. type: integer format: int32 example: 1 buffer_time_before: description: Whole natural number. type: integer format: int32 example: 1 confirmation_page_type: description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl' type: integer example: 0 enum: - 0 - 1 confirmation_page_url: description: URL - HTTP address. type: string example: string is_enabled: description: Boolean value. type: boolean example: false minimum_notice_time: description: Whole natural number. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 planning_day_offset: description: Whole natural number. type: integer format: int32 example: 1 planning_period_from: description: Date information. type: string format: date example: '2019-01-01' planning_period_to: description: Date information. type: string format: date example: '2019-01-01' planning_type: description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period' type: integer example: 0 enum: - 0 - 1 - 2 reminder_email_enabled: description: Boolean value. type: boolean example: false reminder_email_offset: description: Whole natural number. type: integer format: int32 example: 1 reminder_email_offset_type: description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week' type: integer example: 0 enum: - 0 - 1 - 2 - 3 schedule_name: description: String value. type: string example: string time_increment: description: Whole natural number. type: integer format: int32 example: 1 type: description: 'Integer enum value: 0 - OneToOne, 1 - Group' type: integer example: 0 enum: - 0 - 1 url: description: String value. type: string example: string additional_fields_data: description: '' type: array items: type: object properties: field_id: description: Field id type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 label: description: Field label type: string example: string is_required: description: Whether value may be null/empty type: boolean example: false required: - field_id - label - is_required availability_data: description: '' type: object appointment_invitees_data: description: '' type: array items: type: object properties: entity_id: description: Entity id or null type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address type: string example: string type: description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email' type: integer example: 1 enum: - 1 - 2 - 3 required: - email - type required: - is_delete_protected - id - appointment_owner - appointment_type - owner - appointment_description - appointment_location - appointment_owner_id - appointment_subject - appointment_subject_uses_schedule_name - appointment_type_id - buffer_time_after - buffer_time_before - is_enabled - minimum_notice_time - name - owner_id - planning_day_offset - reminder_email_enabled - reminder_email_offset - schedule_name - time_increment - url - additional_fields_data - availability_data - appointment_invitees_data x-stoplight: id: kn82q6yveojf2 createAppointmentScheduleInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_description: description: String value. type: string example: string appointment_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 appointment_location: description: String value. type: string example: string appointment_location_type: description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom' type: integer example: 0 enum: - 0 - 1 - 2 appointment_owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_subject: description: String value. type: string example: string appointment_subject_uses_schedule_name: description: Boolean value. type: boolean example: false appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 availability_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string buffer_time_after: description: Whole natural number. type: integer format: int32 example: 1 buffer_time_before: description: Whole natural number. type: integer format: int32 example: 1 confirmation_page_type: description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl' type: integer example: 0 enum: - 0 - 1 confirmation_page_url: description: URL - HTTP address. type: string example: string is_enabled: description: Boolean value. type: boolean example: false minimum_notice_time: description: Whole natural number. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 planning_day_offset: description: Whole natural number. type: integer format: int32 example: 1 planning_period_from: description: Date information. type: string format: date example: '2019-01-01' planning_period_to: description: Date information. type: string format: date example: '2019-01-01' planning_type: description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period' type: integer example: 0 enum: - 0 - 1 - 2 reminder_email_enabled: description: Boolean value. type: boolean example: false reminder_email_offset: description: Whole natural number. type: integer format: int32 example: 1 reminder_email_offset_type: description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week' type: integer example: 0 enum: - 0 - 1 - 2 - 3 schedule_name: description: String value. type: string example: string time_increment: description: Whole natural number. type: integer format: int32 example: 1 type: description: 'Integer enum value: 0 - OneToOne, 1 - Group' type: integer example: 0 enum: - 0 - 1 url: description: String value. type: string example: string additional_fields_data: description: '' type: array items: type: object properties: field_id: description: Field id type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 label: description: Field label type: string example: string is_required: description: Whether value may be null/empty type: boolean example: false required: - field_id - label - is_required availability_data: description: '' type: object appointment_invitees_data: description: '' type: array items: type: object properties: entity_id: description: Entity id or null type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address type: string example: string type: description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email' type: integer example: 1 enum: - 1 - 2 - 3 required: - email - type required: - appointment_description - appointment_location - appointment_owner_id - appointment_subject - appointment_subject_uses_schedule_name - appointment_type_id - buffer_time_after - buffer_time_before - is_enabled - minimum_notice_time - name - owner_id - planning_day_offset - reminder_email_enabled - reminder_email_offset - schedule_name - time_increment - url - additional_fields_data - availability_data - appointment_invitees_data x-stoplight: id: 66djhg71rinh3 updateAppointmentScheduleInput: properties: appointment_description: description: String value. type: string example: string appointment_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 appointment_location: description: String value. type: string example: string appointment_location_type: description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom' type: integer example: 0 enum: - 0 - 1 - 2 appointment_owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_subject: description: String value. type: string example: string appointment_subject_uses_schedule_name: description: Boolean value. type: boolean example: false appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 availability_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string buffer_time_after: description: Whole natural number. type: integer format: int32 example: 1 buffer_time_before: description: Whole natural number. type: integer format: int32 example: 1 confirmation_page_type: description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl' type: integer example: 0 enum: - 0 - 1 confirmation_page_url: description: URL - HTTP address. type: string example: string is_enabled: description: Boolean value. type: boolean example: false minimum_notice_time: description: Whole natural number. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 planning_day_offset: description: Whole natural number. type: integer format: int32 example: 1 planning_period_from: description: Date information. type: string format: date example: '2019-01-01' planning_period_to: description: Date information. type: string format: date example: '2019-01-01' planning_type: description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period' type: integer example: 0 enum: - 0 - 1 - 2 reminder_email_enabled: description: Boolean value. type: boolean example: false reminder_email_offset: description: Whole natural number. type: integer format: int32 example: 1 reminder_email_offset_type: description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week' type: integer example: 0 enum: - 0 - 1 - 2 - 3 schedule_name: description: String value. type: string example: string time_increment: description: Whole natural number. type: integer format: int32 example: 1 type: description: 'Integer enum value: 0 - OneToOne, 1 - Group' type: integer example: 0 enum: - 0 - 1 url: description: String value. type: string example: string additional_fields_data: description: '' type: array items: type: object properties: field_id: description: Field id type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 label: description: Field label type: string example: string is_required: description: Whether value may be null/empty type: boolean example: false required: - field_id - label - is_required availability_data: description: '' type: object appointment_invitees_data: description: '' type: array items: type: object properties: entity_id: description: Entity id or null type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address type: string example: string type: description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email' type: integer example: 1 enum: - 1 - 2 - 3 required: - email - type x-stoplight: id: wtun90f7teww3 batchAppointmentScheduleInput: properties: appointment_description: description: String value. type: string example: string appointment_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 appointment_location: description: String value. type: string example: string appointment_location_type: description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom' type: integer example: 0 enum: - 0 - 1 - 2 appointment_owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_subject: description: String value. type: string example: string appointment_subject_uses_schedule_name: description: Boolean value. type: boolean example: false appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 availability_tzid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string buffer_time_after: description: Whole natural number. type: integer format: int32 example: 1 buffer_time_before: description: Whole natural number. type: integer format: int32 example: 1 confirmation_page_type: description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl' type: integer example: 0 enum: - 0 - 1 confirmation_page_url: description: URL - HTTP address. type: string example: string is_enabled: description: Boolean value. type: boolean example: false minimum_notice_time: description: Whole natural number. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 planning_day_offset: description: Whole natural number. type: integer format: int32 example: 1 planning_period_from: description: Date information. type: string format: date example: '2019-01-01' planning_period_to: description: Date information. type: string format: date example: '2019-01-01' planning_type: description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period' type: integer example: 0 enum: - 0 - 1 - 2 reminder_email_enabled: description: Boolean value. type: boolean example: false reminder_email_offset: description: Whole natural number. type: integer format: int32 example: 1 reminder_email_offset_type: description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week' type: integer example: 0 enum: - 0 - 1 - 2 - 3 schedule_name: description: String value. type: string example: string time_increment: description: Whole natural number. type: integer format: int32 example: 1 type: description: 'Integer enum value: 0 - OneToOne, 1 - Group' type: integer example: 0 enum: - 0 - 1 url: description: String value. type: string example: string additional_fields_data: description: '' type: array items: type: object properties: field_id: description: Field id type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 label: description: Field label type: string example: string is_required: description: Whether value may be null/empty type: boolean example: false required: - field_id - label - is_required availability_data: description: '' type: object appointment_invitees_data: description: '' type: array items: type: object properties: entity_id: description: Entity id or null type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email address type: string example: string type: description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email' type: integer example: 1 enum: - 1 - 2 - 3 required: - email - type id: description: ID of object to update. type: string format: uuid x-stoplight: id: 8tao1b5cbtjt7 AppointmentType: properties: id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false required: - id - is_readonly - name - has_draft - is_delete_protected - form_edit_api x-stoplight: id: owegxfkx5vffh createAppointmentTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: bym9ih1csznuc updateAppointmentTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: e2rt1f1jep5b8 batchAppointmentTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: vp0xjhb8wn3c4 Approval: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri actor: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri approval_process: description: >- Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 approvers: description: Relations to ApprovalApprovers. type: array items: description: >- Relation to ApprovalApprover. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalApprover' object for properties. type: string format: uri lines: description: Relations to ApprovalProcessActivityLogLines. type: array items: description: >- Relation to ApprovalProcessActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcessActivityLogLine' object for properties. type: string format: uri start_time: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - application - approval_process - application_id - approval_process_id - settings x-stoplight: id: qa64gjubwjyy7 createApprovalInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 approvers: description: Relations to ApprovalApprovers. type: array items: description: >- Relation to ApprovalApprover, see: 'createApprovalApproverInput' object for properties. type: object properties: id: type: string format: uri required: - application_id - approval_process_id x-stoplight: id: plql47h725spm updateApprovalInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 approvers: description: Relations to ApprovalApprovers. type: array items: description: >- Relation to ApprovalApprover, see: 'updateApprovalApproverInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 2k42og20az4b0 batchApprovalInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 approvers: description: Relations to ApprovalApprovers. type: array items: description: >- Relation to ApprovalApprover, see: 'updateApprovalApproverInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: tzkpdk7hq0m1q ApprovalApprover: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true approval: description: >- Relation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - approval - client - approval_id - client_id x-stoplight: id: n52p3zws40d8r createApprovalApproverInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - approval_id - client_id x-stoplight: id: p8tl5zo8pqetu updateApprovalApproverInput: properties: approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 6cogrj8qhw75g batchApprovalApproverInput: properties: approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Multi-line text input field. type: string example: string status: description: 'Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected' type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ihg1qa1zgamfx ApprovalProcess: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 readOnly: true is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 priority: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 settings: description: Field containing json. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri activity_logs: description: Relations to Approvals. type: array items: description: >- Relation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties. type: string format: uri required: - is_delete_protected - id - owner - is_enabled - name - owner_id x-stoplight: id: 179rym1swy4r8 createApprovalProcessInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - is_enabled - name - owner_id x-stoplight: id: 3jjfqayq85sz5 updateApprovalProcessInput: properties: description: description: Multi-line text input field. type: string example: string is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: jhbk1jdyapo0s batchApprovalProcessInput: properties: description: description: Multi-line text input field. type: string example: string is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: lnmjmi36rgldp ApprovalProcessActivityLogLine: properties: formatted_text: description: '' type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true approval: description: >- Relation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties. type: string format: uri approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data: description: Field containing json. type: object executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - formatted_text - is_delete_protected - id - approval - approval_id - data - sort_order x-stoplight: id: hxwo73x1uq5ic createApprovalProcessActivityLogLineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data: description: Field containing json. type: object executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - approval_id - data - sort_order x-stoplight: id: tp238550b90m4 updateApprovalProcessActivityLogLineInput: properties: approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data: description: Field containing json. type: object executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: 1gooxpljrljnw batchApprovalProcessActivityLogLineInput: properties: approval_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data: description: Field containing json. type: object executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: q5wgw49gxwd25 Call: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri caller: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri oppty_product_relation: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri product: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 caller_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 twilio_call_log_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - is_delete_protected - id - caller - caller_id - twilio_call_log_id x-stoplight: id: 67042kl3wwhm9 createCallInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 caller_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 twilio_call_log_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - caller_id - twilio_call_log_id x-stoplight: id: vcdcy2g7o0pfm updateCallInput: properties: oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 caller_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 twilio_call_log_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 x-stoplight: id: eeeh6wt87d91x batchCallInput: properties: oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 caller_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 twilio_call_log_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 id: description: ID of object to update. type: string format: uuid x-stoplight: id: uh5u93nsg3f62 Client: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true default_unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri default_unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email. Readonly information from UserProfile. type: string example: string first_name: description: First name. Readonly information from UserProfile. type: string example: string readOnly: true last_active: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true last_name: description: Last name. Readonly information from UserProfile. type: string example: string readOnly: true master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 middle_name: description: Middle name. Readonly information from UserProfile. type: string example: string readOnly: true phone: description: Phone number. Readonly information from UserProfile. type: string example: string readOnly: true picture_url: description: Picture name. Readonly information from UserProfile. type: string example: string readOnly: true position: description: Simple text input field. type: string example: string region: description: Region. Readonly information from UserProfile. type: string example: string readOnly: true timezone: description: Timezone offset (DEPRECATED)Readonly information from UserProfile. type: string example: string readOnly: true type: description: 'Integer enum value: 0 - Customer, 1 - Support' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 default_idp: description: default_idp retrieved from user, if enabled [HEAVY] type: integer format: int32 example: 1 user_profile_id: description: ID of the associated user account [HEAVY] type: integer format: int32 example: 1 unit_membership: description: Relations to SalesUnits. type: array items: description: >- Relation to SalesUnitClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnitClientRelation' object for properties. type: string format: uri appointment_favorite: description: Relations to Appointments. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri task_favorite: description: Relations to Tasks. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri account_favorite: description: Relations to Accounts. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri contact_favorite: description: Relations to Contacts. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri profile_favorite: description: Relations to Profiles. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri report_favorite: description: Relations to Reports. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri lead_favorite: description: Relations to Leads. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri opportunity_favorite: description: Relations to Opportunitys. type: array items: description: >- Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties. type: string format: uri timezone_name: description: IANA timezone name from UserProfile type: string example: string name: description: '' type: string example: string formatted_name: description: '' type: string example: string unit_manager_ids: description: '' type: array items: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_member_ids: description: '' type: array items: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - is_delete_protected - id - default_unit - master_right - default_unit_id - email - master_right_id - unit_membership - formatted_name - unit_manager_ids - unit_member_ids x-stoplight: id: 33aohs233kv09 createClientInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true default_unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email: description: Email. Readonly information from UserProfile. type: string example: string first_name: description: First name. Readonly information from UserProfile. type: string example: string readOnly: true last_active: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true last_name: description: Last name. Readonly information from UserProfile. type: string example: string readOnly: true master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 middle_name: description: Middle name. Readonly information from UserProfile. type: string example: string readOnly: true phone: description: Phone number. Readonly information from UserProfile. type: string example: string readOnly: true position: description: Simple text input field. type: string example: string region: description: Region. Readonly information from UserProfile. type: string example: string readOnly: true timezone: description: Timezone offset (DEPRECATED)Readonly information from UserProfile. type: string example: string readOnly: true type: description: 'Integer enum value: 0 - Customer, 1 - Support' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 unit_membership: description: Relations to SalesUnits. type: array items: description: >- Relation to SalesUnitClientRelation, see: 'createSalesUnitClientRelationInput' object for properties. type: object properties: id: type: string format: uri appointment_favorite: description: Relations to Appointments. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri task_favorite: description: Relations to Tasks. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri account_favorite: description: Relations to Accounts. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri contact_favorite: description: Relations to Contacts. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri profile_favorite: description: Relations to Profiles. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri report_favorite: description: Relations to Reports. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri lead_favorite: description: Relations to Leads. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri opportunity_favorite: description: Relations to Opportunitys. type: array items: description: >- Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri required: - default_unit_id - email - master_right_id - unit_membership x-stoplight: id: aiq4v8ivuphgu updateClientInput: properties: default_unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string type: description: 'Integer enum value: 0 - Customer, 1 - Support' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 unit_membership: description: Relations to SalesUnits. type: array items: description: >- Relation to SalesUnitClientRelation, see: 'updateSalesUnitClientRelationInput' object for properties. type: object properties: id: type: string format: uri appointment_favorite: description: Relations to Appointments. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri task_favorite: description: Relations to Tasks. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri account_favorite: description: Relations to Accounts. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri contact_favorite: description: Relations to Contacts. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri profile_favorite: description: Relations to Profiles. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri report_favorite: description: Relations to Reports. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri lead_favorite: description: Relations to Leads. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri opportunity_favorite: description: Relations to Opportunitys. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 9k1jqzlbrjrjg batchClientInput: properties: default_unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string type: description: 'Integer enum value: 0 - Customer, 1 - Support' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 unit_membership: description: Relations to SalesUnits. type: array items: description: >- Relation to SalesUnitClientRelation, see: 'updateSalesUnitClientRelationInput' object for properties. type: object properties: id: type: string format: uri appointment_favorite: description: Relations to Appointments. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri task_favorite: description: Relations to Tasks. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri account_favorite: description: Relations to Accounts. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri contact_favorite: description: Relations to Contacts. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri profile_favorite: description: Relations to Profiles. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri report_favorite: description: Relations to Reports. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri lead_favorite: description: Relations to Leads. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri opportunity_favorite: description: Relations to Opportunitys. type: array items: description: >- Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 78r6bg5pwhap4 ClientExcludedOppty: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri is_excluded: description: Boolean value. type: boolean example: false oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - oppty - owner - is_excluded - oppty_id - owner_id x-stoplight: id: 0faj5ofktlrit createClientExcludedOpptyInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true is_excluded: description: Boolean value. type: boolean example: false oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_excluded - oppty_id - owner_id x-stoplight: id: 0msk9wb1gogus updateClientExcludedOpptyInput: properties: is_excluded: description: Boolean value. type: boolean example: false oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: b8oyk9q83zbp1 batchClientExcludedOpptyInput: properties: is_excluded: description: Boolean value. type: boolean example: false oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7tt3noh5uos7n ClientFavorite: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri profile: description: >- Relation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri report: description: >- Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - owner_id x-stoplight: id: imt50d7h635v8 createClientFavoriteInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - owner_id x-stoplight: id: gl9myegeolwvc updateClientFavoriteInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: dglqq8eykj7aa batchClientFavoriteInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 3v29bumpoik2e ClientSetting: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - name - owner_id - value x-stoplight: id: l89t3c4qnldj5 ClientStoryRead: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri email: description: >- 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. type: string format: uri memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 no_follow: description: Boolean value. type: boolean example: false owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 read_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - owner_id - read_at x-stoplight: id: 3s74xlubpa7a6 createClientStoryReadInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 no_follow: description: Boolean value. type: boolean example: false owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 read_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - owner_id - read_at x-stoplight: id: dahgfnv7c3dbb updateClientStoryReadInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 no_follow: description: Boolean value. type: boolean example: false owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 read_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: qo4vhxu64b3j1 batchClientStoryReadInput: properties: activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 no_follow: description: Boolean value. type: boolean example: false owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 read_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: x4wh4mzufna6f CloudObject: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri company_cloud_object_folder: description: >- Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties. type: string format: uri creator: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false mime_type: description: Mime-type of the cloud object Is detected from content. type: string example: string readOnly: true params: description: Field containing json. type: object size: description: Size of the object in bytes. type: integer format: int32 example: 1 readOnly: true type: description: >- Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true url: description: >- URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. type: string example: string readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 public_url: description: returns public url for cloud object type: string example: string required: - is_delete_protected - id - filename - size - type x-stoplight: id: ppjrdzawry0ui createCloudObjectInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false mime_type: description: Mime-type of the cloud object Is detected from content. type: string example: string readOnly: true params: description: Field containing json. type: object type: description: >- Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true url: description: >- URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. type: string example: string readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 content: description: Data content of the object. type: string format: binary example: blob required: - filename - type x-stoplight: id: rl92timpdmt3r updateCloudObjectInput: properties: application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false params: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: jb4h38emn5loa batchCloudObjectInput: properties: application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false params: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7oo5hz0jmk8r2 CloudObjectFolder: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true parent_cloud_object_folder: description: >- Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties. type: string format: uri entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 name: description: Name of the entity and its default text representation. type: string example: string parent_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - name x-stoplight: id: cvinjp8v38l2p createCloudObjectFolderInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 name: description: Name of the entity and its default text representation. type: string example: string parent_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name x-stoplight: id: 8ummq9n51lgxk updateCloudObjectFolderInput: properties: entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string parent_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 7errh9yozhmlm batchCloudObjectFolderInput: properties: entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string parent_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: s8izlkju6dl5a CloudObjectRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri approval_process: description: >- Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties. type: string format: uri cloud_object_folder: description: >- Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties. type: string format: uri cloud_object: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri email_sequence: description: >- Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. type: string format: uri email_template: description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri email: description: >- 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. type: string format: uri memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri process: description: >- Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties. type: string format: uri process_template: description: >- Relation to ProcessTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessTemplate' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri report_schedule: description: >- Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id x-stoplight: id: criyn9h8l29no createCloudObjectRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cloud_object: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri report_schedule: description: >- Relation to ReportSchedule, see: 'createReportScheduleInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: ymokkqxunhg38 updateCloudObjectRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri report_schedule: description: >- Relation to ReportSchedule, see: 'updateReportScheduleInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 6kbv2627y5ag5 batchCloudObjectRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri report_schedule: description: >- Relation to ReportSchedule, see: 'updateReportScheduleInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 approval_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 process_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: xfy0v9efl73ek CloudObjectStepRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cloud_object: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - cloud_object - step - step_id x-stoplight: id: qmwloiigm287e createCloudObjectStepRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cloud_object: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - cloud_object - step_id x-stoplight: id: 16jnm1dg3jj1l updateCloudObjectStepRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: rwb3txd218zh0 batchCloudObjectStepRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: oyo3b2381jk5m CloudObjectTemplate: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri company_cloud_object_folder: description: >- Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties. type: string format: uri creator: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false mime_type: description: Mime-type of the cloud object Is detected from content. type: string example: string readOnly: true size: description: Size of the object in bytes. type: integer format: int32 example: 1 readOnly: true status: description: 'Integer enum value: 1 - Active, 2 - Inactive' type: integer example: 1 enum: - 1 - 2 template_entity_name: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: Account enum: - Account - AccountKPI - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityKPI - ActivityRelation - ActivityType - AllowedLeadType - AllowedPipeline - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - AllowedAccountType - AllowedContactType - AllowedCompanyPhone - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountRelation - ContactAccountAccountRoleRelation - ContactRelation - ContactRelationType - ContactKPI - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntityRelation - CustomEntityRelationData - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - DataRelation - Email - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - Entity - EntityHealth - EntityScoring - EntityHealthSettingsHistory - EntityFitness - EntityFitnessIndicator - EntityType - Field - FieldSequence - FieldPermission - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - GhostContact - GhostLeadOpptyContactRelation - GhostContactAccountRelation - GhostLeadOpptyContactSalesRoleRelation - GhostContactAccountAccountRoleRelation - ImportMappingMask - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormTypeEmailRelation - OnlineFormRelation - OnlineFormType - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - Order - OrderItem - OrderTempDataItem - OrderHistory - OrderRelatedDocument - OrderTempData - Payment - PaymentTerm - PaymentAdditionalData - ParentAccountRelationType - Phone - AllowedQuoteType - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - LeadOpptyDataExRelation - AccountDataExRelation - ContactDataExRelation - ActivityDataExRelation - ProductDataExRelation - ProjectDataExRelation - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessScheduledAction - ProcessTemplate - Product - ProductType - ProductCategory - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - Profile - ProfileDraft - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectKPI - ProjectContactRelation - ProjectObjective - ProjectType - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - Report - ReportFolder - ReportSharingClientRelation - ReportSharingSalesUnitRelation - ReportSchedule - SalesRole - SalesUnit - SalesUnitClientRelation - Step - StepChecklist - StepChecklistSalesRoleRelation - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TextMessage - TextMessageConversation - TextMessageConversationRelations - Translation - Type - Timeframe - UnsubscribedPhone - Webresource - Webhook - WebhookEvent - Country - TeamSpaceClient - CpTeamSpaceClient - CpCallLog - UserProfile - UserRole - TeamSpace - TeamSpaceRegion - TeamSpaceProperty - TeamSpaceClientSetting - SapiUser - CpCalling - Subscription - SubscriptionRepresentative - SubscriptionSDR - Partner - Supplier - State - AutomationHubApp - AutomationHubCategory - AutomationHubItem - SubscriptionHubItem - TeamPipelineHubItem - HowTo - CpClient - CpProfile - SubscriptionNotification - CpActivity - ActivityDetail - NotificationSetting - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - InterfacePreview - SpaceSetting readOnly: true type: description: >- Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true url: description: >- URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. type: string example: string readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - filename - size - template_entity_name - type x-stoplight: id: rctm2lpqdpanr createCloudObjectTemplateInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false status: description: 'Integer enum value: 1 - Active, 2 - Inactive' type: integer example: 1 enum: - 1 - 2 template_entity_name: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: Account enum: - Account - AccountKPI - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityKPI - ActivityRelation - ActivityType - AllowedLeadType - AllowedPipeline - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - AllowedAccountType - AllowedContactType - AllowedCompanyPhone - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountRelation - ContactAccountAccountRoleRelation - ContactRelation - ContactRelationType - ContactKPI - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntityRelation - CustomEntityRelationData - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - DataRelation - Email - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - Entity - EntityHealth - EntityScoring - EntityHealthSettingsHistory - EntityFitness - EntityFitnessIndicator - EntityType - Field - FieldSequence - FieldPermission - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - GhostContact - GhostLeadOpptyContactRelation - GhostContactAccountRelation - GhostLeadOpptyContactSalesRoleRelation - GhostContactAccountAccountRoleRelation - ImportMappingMask - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormTypeEmailRelation - OnlineFormRelation - OnlineFormType - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - Order - OrderItem - OrderTempDataItem - OrderHistory - OrderRelatedDocument - OrderTempData - Payment - PaymentTerm - PaymentAdditionalData - ParentAccountRelationType - Phone - AllowedQuoteType - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - LeadOpptyDataExRelation - AccountDataExRelation - ContactDataExRelation - ActivityDataExRelation - ProductDataExRelation - ProjectDataExRelation - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessScheduledAction - ProcessTemplate - Product - ProductType - ProductCategory - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - Profile - ProfileDraft - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectKPI - ProjectContactRelation - ProjectObjective - ProjectType - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - Report - ReportFolder - ReportSharingClientRelation - ReportSharingSalesUnitRelation - ReportSchedule - SalesRole - SalesUnit - SalesUnitClientRelation - Step - StepChecklist - StepChecklistSalesRoleRelation - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TextMessage - TextMessageConversation - TextMessageConversationRelations - Translation - Type - Timeframe - UnsubscribedPhone - Webresource - Webhook - WebhookEvent - Country - TeamSpaceClient - CpTeamSpaceClient - CpCallLog - UserProfile - UserRole - TeamSpace - TeamSpaceRegion - TeamSpaceProperty - TeamSpaceClientSetting - SapiUser - CpCalling - Subscription - SubscriptionRepresentative - SubscriptionSDR - Partner - Supplier - State - AutomationHubApp - AutomationHubCategory - AutomationHubItem - SubscriptionHubItem - TeamPipelineHubItem - HowTo - CpClient - CpProfile - SubscriptionNotification - CpActivity - ActivityDetail - NotificationSetting - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - InterfacePreview - SpaceSetting readOnly: true type: description: >- Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true url: description: >- URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. type: string example: string readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 content: description: Data content of the object. type: string format: binary example: blob required: - filename - template_entity_name - type x-stoplight: id: 8iqbrskzxweqo updateCloudObjectTemplateInput: properties: application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false status: description: 'Integer enum value: 1 - Active, 2 - Inactive' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 content: description: Data content of the object. type: string format: binary example: blob x-stoplight: id: ou8fx5qwwc2w8 batchCloudObjectTemplateInput: properties: application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 company_cloud_object_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 filename: description: Simple text input field. type: string example: string is_public: description: Boolean value. type: boolean example: false status: description: 'Integer enum value: 1 - Active, 2 - Inactive' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 content: description: Data content of the object. type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: 02rmv199lq1gh CompanyEmail: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: Email address. type: string example: string enabled: description: '' type: boolean example: false error_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: String value. type: string example: string picture_url: description: URL - HTTP address. type: string example: string service_type: description: 'Integer enum value: 1 - O365Email, 2 - GoogleEmail' type: integer example: 1 enum: - 1 - 2 required: - is_delete_protected - id - enabled - name - service_type x-stoplight: id: epkwp9r9z1gxh Contact: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties. type: string format: uri title: description: Simple text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' contact_type: description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri picture: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string first_name: description: Simple text input field. type: string example: string gender: description: 'Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_archived: description: Boolean value. type: boolean example: false last_name: description: Simple text input field. type: string example: string middle_name: description: Simple text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 formatted_name: description: '' type: string example: string social_media: description: >- Relation to ContactSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSocialRelation' object for properties. type: string format: uri primary_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountRelation' object for properties. type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ContactSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ContactSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSharingClientRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri is_favorite: description: '' type: boolean example: false primary_account_account_roles: description: Roles of Contact in his primary Account. type: array items: description: >- Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountAccountRoleRelation' object for properties. type: string format: uri primary_account_position: description: Job position of Contact in his primary Account. type: string example: string account_position: description: >- Job position of Contact in his primary Account or quick account position if Contact has no primary Account. type: string example: string is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false primary_account_relationship: description: Org chart relationship of Contact in his primary Account. type: string example: string modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - contact_type - owner - unit - owner_id - formatted_name - is_favorite x-stoplight: id: 0nr5fmmiwafsu createContactInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'createTagRelationInput' object for properties. type: object properties: id: type: string format: uri title: description: Simple text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string first_name: description: Simple text input field. type: string example: string gender: description: 'Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_archived: description: Boolean value. type: boolean example: false last_name: description: Simple text input field. type: string example: string middle_name: description: Simple text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to ContactSocialRelation, see: 'createContactSocialRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ContactAccountRelation, see: 'createContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ContactSharingSalesUnitRelation, see: 'createContactSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ContactSharingClientRelation, see: 'createContactSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri primary_account_account_roles: description: Roles of Contact in his primary Account. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'createContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri account_position: description: >- Job position of Contact in his primary Account or quick account position if Contact has no primary Account. type: string example: string is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false primary_account_relationship: description: Org chart relationship of Contact in his primary Account. type: string example: string required: - owner_id x-stoplight: id: 7l2q8jbdgswko updateContactInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri title: description: Simple text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string first_name: description: Simple text input field. type: string example: string gender: description: 'Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_archived: description: Boolean value. type: boolean example: false last_name: description: Simple text input field. type: string example: string middle_name: description: Simple text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ContactSharingSalesUnitRelation, see: 'updateContactSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ContactSharingClientRelation, see: 'updateContactSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string primary_account_account_roles: description: Roles of Contact in his primary Account. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri account_position: description: >- Job position of Contact in his primary Account or quick account position if Contact has no primary Account. type: string example: string is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false primary_account_relationship: description: Org chart relationship of Contact in his primary Account. type: string example: string x-stoplight: id: rzoatxdptgicm batchContactInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri title: description: Simple text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri address: description: Multi-line text input field. type: string example: string city: description: Simple text input field. type: string example: string comments: description: Multi-line text input field. type: string example: string contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 country: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string email1: description: Email address. type: string example: string email2: description: Email address. type: string example: string email3: description: Email address. type: string example: string email4: description: Email address. type: string example: string email5: description: Email address. type: string example: string first_name: description: Simple text input field. type: string example: string gender: description: 'Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_archived: description: Boolean value. type: boolean example: false last_name: description: Simple text input field. type: string example: string middle_name: description: Simple text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone1: description: Phone number. type: string example: string phone2: description: Phone number. type: string example: string phone3: description: Phone number. type: string example: string phone4: description: Phone number. type: string example: string phone5: description: Phone number. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 state_province: description: Simple text input field. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 zip_code: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 social_media: description: >- Relation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ContactSharingSalesUnitRelation, see: 'updateContactSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ContactSharingClientRelation, see: 'updateContactSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string primary_account_account_roles: description: Roles of Contact in his primary Account. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri account_position: description: >- Job position of Contact in his primary Account or quick account position if Contact has no primary Account. type: string example: string is_unsubscribed: description: If account has any unsubscribed email. type: boolean example: false primary_account_relationship: description: Org chart relationship of Contact in his primary Account. type: string example: string id: description: ID of object to update. type: string format: uuid x-stoplight: id: 4wtnqrx1mb8ls ContactAccountAccountRoleRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_role: description: >- Relation to AccountRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRole' object for properties. type: string format: uri contact_account_relation: description: >- Relation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountRelation' object for properties. type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account_role - contact_account_relation - account_role_id - contact_account_relation_id x-stoplight: id: karl5u1y8vect createContactAccountAccountRoleRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_account_relation: description: >- Relation to ContactAccountRelation, see: 'createContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_account_relation - account_role_id - contact_account_relation_id x-stoplight: id: liibpkw7dz7wz updateContactAccountAccountRoleRelationInput: properties: contact_account_relation: description: >- Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: aowu2cui38g8x batchContactAccountAccountRoleRelationInput: properties: contact_account_relation: description: >- Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: cu1h6oaoii1bg ContactAccountRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_primary: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountAccountRoleRelation' object for properties. type: string format: uri required: - is_delete_protected - id - account - contact - account_id - contact_id - is_primary x-stoplight: id: 35vyxbu4yyg1p createContactAccountRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_primary: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'createContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri required: - account_id - contact_id - is_primary x-stoplight: id: w6qmrpdk6u1jd updateContactAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_primary: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 4hnnynu5zr84n batchContactAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_primary: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: nb6fq6qdfvy00 ContactDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri data: description: >- 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. type: string format: uri contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact - data - contact_id - data_id - data_set_id x-stoplight: id: egkcrl6i6bzd1 ContactKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact - owner - contact_id - kpi - owner_id x-stoplight: id: yntkt6o7wuf46 createContactKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_id - kpi - owner_id x-stoplight: id: a0gppswqin19u updateContactKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: bi9rblzxt4j5u batchContactKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 9xqqxnffvaswn ContactRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact1: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri contact2: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri contact1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact1 - contact2 - contact1_id - contact2_id x-stoplight: id: u2ed68wnutqqd createContactRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact1_id - contact2_id x-stoplight: id: j6s9sgheelgur updateContactRelationInput: properties: contact1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 76xv7un992ni3 batchContactRelationInput: properties: contact1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6dx1dcswxmoh7 ContactRelationLabel: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_relation: description: >- Relation to ContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactRelation' object for properties. type: string format: uri contact_relation_type: description: >- Relation to ContactRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactRelationType' object for properties. type: string format: uri contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact_relation - contact_relation_type - contact_relation_id - contact_relation_type_id x-stoplight: id: 9sjnn07wx3ris createContactRelationLabelInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_relation: description: >- Relation to ContactRelation, see: 'createContactRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_relation - contact_relation_id - contact_relation_type_id x-stoplight: id: jszycp7v2e4mq updateContactRelationLabelInput: properties: contact_relation: description: >- Relation to ContactRelation, see: 'updateContactRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: bfsxa3n3vsid7 batchContactRelationLabelInput: properties: contact_relation: description: >- Relation to ContactRelation, see: 'updateContactRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5wgnzjau315s0 ContactRelationType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color x-stoplight: id: lc5dnim5eoyy3 createContactRelationTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color x-stoplight: id: busokyi7rpmlr updateContactRelationTypeInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: b24pe26dy2nf4 batchContactRelationTypeInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 73qcvghlnrhlz ContactSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - contact - client_id - contact_id x-stoplight: id: 5llf39acmm7ki createContactSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - contact_id x-stoplight: id: fvgfkdmzyfkr6 updateContactSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: k5ughzyu1wrv0 batchContactSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 227e2nidl04mb ContactSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact - unit - contact_id - unit_id x-stoplight: id: srmxrx2aqb548 createContactSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_id - unit_id x-stoplight: id: tqlfiu6eyw8ab updateContactSharingSalesUnitRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 906eyn5cnos8r batchContactSharingSalesUnitRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: x2glqa7xk8ijw ContactSocialRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. Must match with Contact id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id x-stoplight: id: px98xw8zbm9jp createContactSocialRelationInput: properties: id: description: Unique identifier of entity. Must match with Contact id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - id x-stoplight: id: 0jlrj885yuijg updateContactSocialRelationInput: properties: angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 0zxup2qz3xkxh batchContactSocialRelationInput: properties: angellist_url: description: URL - HTTP address. type: string example: string crunchbase_url: description: URL - HTTP address. type: string example: string disqus_url: description: URL - HTTP address. type: string example: string facebook_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string facebook_url: description: URL - HTTP address. type: string example: string flickr_url: description: URL - HTTP address. type: string example: string foursquare_url: description: URL - HTTP address. type: string example: string google_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string google_plus_url: description: URL - HTTP address. type: string example: string gravatar_url: description: URL - HTTP address. type: string example: string klout_url: description: URL - HTTP address. type: string example: string linkedin_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string linkedin_url: description: URL - HTTP address. type: string example: string pinterest_url: description: URL - HTTP address. type: string example: string quora_url: description: URL - HTTP address. type: string example: string reddit_url: description: URL - HTTP address. type: string example: string skype_url: description: URL - HTTP address. type: string example: string slideshare_url: description: URL - HTTP address. type: string example: string twitter_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string twitter_url: description: URL - HTTP address. type: string example: string vimeo_url: description: URL - HTTP address. type: string example: string wordpress_url: description: URL - HTTP address. type: string example: string xing_url: description: URL - HTTP address. type: string example: string yahoo_url: description: URL - HTTP address. type: string example: string yelp_url: description: URL - HTTP address. type: string example: string youtube_url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7ebvxlomzgram ContactType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name x-stoplight: id: mfcli7b0pakb8 createContactTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: 4vwm8rujovdox updateContactTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: ou8u4i48r9h3y batchContactTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: q6g83iozxxj69 Currency: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true code: description: Name of the entity and its default text representation. type: string example: string is_base: description: Boolean value. type: boolean example: false readOnly: true symbol: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to CurrencyExchangeRatesLists. type: array items: description: >- Relation to CurrencyExchangeRate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRate' object for properties. type: string format: uri required: - is_delete_protected - id - code - currency_exchange_rates x-stoplight: id: 7bg4jwremrkjf createCurrencyInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true code: description: Name of the entity and its default text representation. type: string example: string symbol: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to CurrencyExchangeRatesLists. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'createCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri required: - code - currency_exchange_rates x-stoplight: id: t6dl3lyt5wk34 updateCurrencyInput: properties: revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to CurrencyExchangeRatesLists. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 09fmsr40qtsaw batchCurrencyInput: properties: revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to CurrencyExchangeRatesLists. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: c8h6z7uwgf01q CurrencyExchangeRate: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true currency_exchange_rate_list: description: >- 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. type: string format: uri currency: description: >- 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. type: string format: uri currency_exchange_rate_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 exchange_rate: description: Decimal number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - currency_exchange_rate_list - currency - currency_exchange_rate_list_id - currency_id x-stoplight: id: uatrdblnjasv0 createCurrencyExchangeRateInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true currency_exchange_rate_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 exchange_rate: description: Decimal number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - currency_exchange_rate_list_id - currency_id x-stoplight: id: rpvskgmuz7tsb updateCurrencyExchangeRateInput: properties: currency_exchange_rate_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 exchange_rate: description: Decimal number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: bk9rmwo1gwm4y batchCurrencyExchangeRateInput: properties: currency_exchange_rate_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 exchange_rate: description: Decimal number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: w2120fd5ia209 CurrencyExchangeRatesList: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true valid_from: description: '' type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to Currencys. type: array items: description: >- Relation to CurrencyExchangeRate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRate' object for properties. type: string format: uri required: - is_delete_protected - id - valid_from - currency_exchange_rates x-stoplight: id: bb22es3llucn3 createCurrencyExchangeRatesListInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true valid_from: description: '' type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to Currencys. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'createCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri required: - valid_from - currency_exchange_rates x-stoplight: id: t7rqvvenfzif2 updateCurrencyExchangeRatesListInput: properties: valid_from: description: '' type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to Currencys. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: hy9jmsfezgi8m batchCurrencyExchangeRatesListInput: properties: valid_from: description: '' type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 currency_exchange_rates: description: Relations to Currencys. type: array items: description: >- Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: me5nxf7986mh7 CustomEntity: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri type: description: >- Relation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to CustomEntitySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntitySharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to CustomEntitySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntitySharingClientRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri is_favorite: description: '' type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - type - unit - owner_id - table_name - is_favorite x-stoplight: id: q5r1n0jjzsjz3 createCustomEntityInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to CustomEntitySharingSalesUnitRelation, see: 'createCustomEntitySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to CustomEntitySharingClientRelation, see: 'createCustomEntitySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - owner_id x-stoplight: id: wrei3u83kds1f updateCustomEntityInput: properties: name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to CustomEntitySharingSalesUnitRelation, see: 'updateCustomEntitySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to CustomEntitySharingClientRelation, see: 'updateCustomEntitySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: swkfml40kjkha batchCustomEntityInput: properties: name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to CustomEntitySharingSalesUnitRelation, see: 'updateCustomEntitySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to CustomEntitySharingClientRelation, see: 'updateCustomEntitySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 24funurhkqzxi CustomEntityDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri data: description: >- 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. type: string format: uri custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - custom_entity - data - custom_entity_id - data_id - data_set_id x-stoplight: id: q2ws94ovlr3s8 createCustomEntityDataExRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - custom_entity_id - data_id - data_set_id x-stoplight: id: z1lus9x5d1ugy updateCustomEntityDataExRelationInput: properties: custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: jkehvbhw3qi2a batchCustomEntityDataExRelationInput: properties: custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 31lu50x4e4agc CustomEntityRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true field_1: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri field_2: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri entity_filter_1: description: Field containing json. type: object entity_filter_2: description: Field containing json. type: object field_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 has_is_primary: description: Boolean value. type: boolean example: false show_related_1: description: Boolean value. type: boolean example: false show_related_2: description: Boolean value. type: boolean example: false show_tab_1: description: Boolean value. type: boolean example: false show_tab_2: description: Boolean value. type: boolean example: false tab_name_1: description: String value. type: string example: string tab_name_2: description: String value. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - has_draft - id - field_1 - field_2 - field_1_id - field_2_id - show_tab_1 - show_tab_2 - tab_name_1 - tab_name_2 x-stoplight: id: e8nb5u2p8x6wx CustomEntityRelationData: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_1: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri account_2: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri appointment_1: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task_1: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri appointment_2: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task_2: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri client_1: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri client_2: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri contact_1: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri contact_2: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity_1: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri custom_entity_2: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri custom_entity_relation: description: >- Relation to CustomEntityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityRelation' object for properties. type: string format: uri lead_1: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty_1: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri lead_2: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty_2: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri oppty_product_relation_1: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri oppty_product_relation_2: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri product_1: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri product_2: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri project_1: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri project_2: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote_1: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri quote_2: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 account_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_1_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 activity_2_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_1_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_2_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_1_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_2_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - custom_entity_relation - custom_entity_relation_id x-stoplight: id: q5kp3s6d39syl CustomEntitySharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - custom_entity - client_id - custom_entity_id x-stoplight: id: e5jeqzudbnubh createCustomEntitySharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - custom_entity_id x-stoplight: id: xh5nqwjtqla9w updateCustomEntitySharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 5xq2be2blm7h9 batchCustomEntitySharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6be1h86bsmjac CustomEntitySharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - custom_entity - unit - custom_entity_id - unit_id x-stoplight: id: v1apiycihzkfh createCustomEntitySharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - custom_entity_id - unit_id x-stoplight: id: rtvjrn34ejwqg updateCustomEntitySharingSalesUnitRelationInput: properties: custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: b7efzy4xk7toj batchCustomEntitySharingSalesUnitRelationInput: properties: custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: za17m5sibyhq8 CustomEntityType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true entity_api_name: description: '' type: string example: string required: - has_draft - is_delete_protected - form_edit_api - id - form_edit - is_readonly - name x-stoplight: id: 5q285kr59hme8 createCustomEntityTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true required: - form_edit - is_readonly - name x-stoplight: id: qzzlhijtuyhqv updateCustomEntityTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string x-stoplight: id: sfx004w85s7he batchCustomEntityTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string id: description: ID of object to update. type: string format: uuid x-stoplight: id: 9a6n8ndlfi562 Data: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true calc_value: description: Floating point number. type: number format: double example: 4.32 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true option_name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 option_name_translations: description: '' type: string format: binary example: blob option_name_translated: description: '' type: string example: string required: - is_delete_protected - has_draft - id - data_set_id - option_name - sort_order - option_name_translations - option_name_translated x-stoplight: id: qdpgx676wqxzy createDataInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true calc_value: description: Floating point number. type: number format: double example: 4.32 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true option_name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 option_name_translations: description: '' type: string format: binary example: blob required: - data_set_id - option_name - sort_order - option_name_translations x-stoplight: id: zro7h15s3jky3 updateDataInput: properties: calc_value: description: Floating point number. type: number format: double example: 4.32 option_name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 option_name_translations: description: '' type: string format: binary example: blob x-stoplight: id: fwlukph1uvshu batchDataInput: properties: calc_value: description: Floating point number. type: number format: double example: 4.32 option_name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 option_name_translations: description: '' type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: 9d9emmf2bwtjs DataRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri parent_data: description: >- 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. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - has_draft - id - data - parent_data - data_id - parent_data_id x-stoplight: id: gpsxuzincvbt2 createDataRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - data_id - parent_data_id x-stoplight: id: ujo3gdxug0fo5 updateDataRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: aeo0f0ntyjq59 batchDataRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5x6sid5bs9iwm Email: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true company_email: description: >- Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri parent_email: description: >- 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. type: string format: uri sender_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri sender_client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri sender_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri template: description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. type: string format: uri additional_headers: description: Field containing json. type: object body: description: Html text input field. type: string example: string body_summary: description: Multi-line text input field. type: string example: string cc: description: Multi-line text input field. type: string example: string company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 content_share_mode: description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' type: integer example: 0 enum: - 0 - 1 - 2 content_type: description: Simple text input field. type: string example: string date_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 error_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_tracked: description: Boolean value. type: boolean example: false original_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender: description: Multi-line text input field. type: string example: string sender_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: Name of the entity and its default text representation. type: string example: string table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 thread_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string to: description: Multi-line text input field. type: string example: string type: description: 'Integer enum value: 1 - Standard, 2 - Mass' type: integer example: 1 enum: - 1 - 2 uid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingClientRelation' object for properties. type: string format: uri content_sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailContentSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingSalesUnitRelation' object for properties. type: string format: uri content_sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailContentSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingClientRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri required: - is_delete_protected - id - direction - table_name - uid x-stoplight: id: ydngceafre2q0 createEmailInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true additional_headers: description: Field containing json. type: object body: description: Html text input field. type: string example: string body_summary: description: Multi-line text input field. type: string example: string cc: description: Multi-line text input field. type: string example: string company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 content_share_mode: description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' type: integer example: 0 enum: - 0 - 1 - 2 content_type: description: Simple text input field. type: string example: string date_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 error_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_tracked: description: Boolean value. type: boolean example: false original_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender: description: Multi-line text input field. type: string example: string sender_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: Name of the entity and its default text representation. type: string example: string template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 thread_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string to: description: Multi-line text input field. type: string example: string type: description: 'Integer enum value: 1 - Standard, 2 - Mass' type: integer example: 1 enum: - 1 - 2 uid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'createMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'createMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailContentSharingSalesUnitRelation, see: 'createEmailContentSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailContentSharingClientRelation, see: 'createEmailContentSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - direction - uid x-stoplight: id: 9lkkite6offiq updateEmailInput: properties: additional_headers: description: Field containing json. type: object body: description: Html text input field. type: string example: string body_summary: description: Multi-line text input field. type: string example: string cc: description: Multi-line text input field. type: string example: string company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 content_share_mode: description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' type: integer example: 0 enum: - 0 - 1 - 2 content_type: description: Simple text input field. type: string example: string date_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 error_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_tracked: description: Boolean value. type: boolean example: false original_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender: description: Multi-line text input field. type: string example: string sender_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: Name of the entity and its default text representation. type: string example: string template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 thread_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string to: description: Multi-line text input field. type: string example: string type: description: 'Integer enum value: 1 - Standard, 2 - Mass' type: integer example: 1 enum: - 1 - 2 uid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailContentSharingSalesUnitRelation, see: 'updateEmailContentSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailContentSharingClientRelation, see: 'updateEmailContentSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: ha6mk7m971ax6 batchEmailInput: properties: additional_headers: description: Field containing json. type: object body: description: Html text input field. type: string example: string body_summary: description: Multi-line text input field. type: string example: string cc: description: Multi-line text input field. type: string example: string company_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 content_share_mode: description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' type: integer example: 0 enum: - 0 - 1 - 2 content_type: description: Simple text input field. type: string example: string date_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 error_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 is_tracked: description: Boolean value. type: boolean example: false original_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender: description: Multi-line text input field. type: string example: string sender_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sender_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: Name of the entity and its default text representation. type: string example: string template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 thread_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string to: description: Multi-line text input field. type: string example: string type: description: 'Integer enum value: 1 - Standard, 2 - Mass' type: integer example: 1 enum: - 1 - 2 uid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailContentSharingSalesUnitRelation, see: 'updateEmailContentSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri content_sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailContentSharingClientRelation, see: 'updateEmailContentSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: jtg0s4kidmo8m EmailContentSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri email: description: >- 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. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - email - client_id - email_id x-stoplight: id: l2flh848bi3k7 createEmailContentSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - email_id x-stoplight: id: kg949t1tiaiy6 updateEmailContentSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: tetl80f8acrfk batchEmailContentSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ur03ax9topife EmailContentSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: >- 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. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - email - unit - email_id - unit_id x-stoplight: id: oladre6hs79ux createEmailContentSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - email_id - unit_id x-stoplight: id: zehn0u6n12ych updateEmailContentSharingSalesUnitRelationInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: z4hihwtxblepf batchEmailContentSharingSalesUnitRelationInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: jlt7w3k1n5c26 EmailEvent: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: >- 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. type: string format: uri email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 url: description: URL - HTTP address. type: string example: string required: - is_delete_protected - id - email - email_id x-stoplight: id: hba1w6anydhny createEmailEventInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 url: description: URL - HTTP address. type: string example: string required: - email_id x-stoplight: id: d94rjx3zn94yd updateEmailEventInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 url: description: URL - HTTP address. type: string example: string x-stoplight: id: he01lvvpiwg72 batchEmailEventInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 url: description: URL - HTTP address. type: string example: string id: description: ID of object to update. type: string format: uuid x-stoplight: id: ftz61g0iyoihl EmailSequence: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri deactivation_reason: description: >- Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 activity_logs: description: Relations to EmailSequenceActivityLogs. type: array items: description: >- Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri enrolled: description: Relations to EmailSequenceEnrolleds. type: array items: description: >- Relation to EmailSequenceEnrolled. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceEnrolled' object for properties. type: string format: uri required: - is_delete_protected - id - owner - name - owner_id - type x-stoplight: id: 1bxg8cdyfv9uh createEmailSequenceInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - name - owner_id - type x-stoplight: id: s0x0719va2hhm updateEmailSequenceInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 08z034kvfo8lq batchEmailSequenceInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: wt02f3dhtgu3u EmailSequenceActivityLog: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true actor: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri email_sequence: description: >- Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. type: string format: uri actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 lines: description: Relations to EmailSequenceActivityLogLines. type: array items: description: >- Relation to EmailSequenceActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLogLine' object for properties. type: string format: uri record_name: description: '' type: string example: string record_email: description: '' type: string example: string required: - is_delete_protected - id - application - email_sequence - application_id - email_sequence_id - start_time - status x-stoplight: id: 6ggip0fuosmhh createEmailSequenceActivityLogInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - application_id - email_sequence_id - start_time - status x-stoplight: id: yb17i2s0mly9h updateEmailSequenceActivityLogInput: properties: actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: aacmkmfyffbun batchEmailSequenceActivityLogInput: properties: actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 1esgppn6u36ot EmailSequenceActivityLogLine: properties: formatted_text: description: '' type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_sequence_activity_log: description: >- Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties. type: string format: uri email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - formatted_text - is_delete_protected - id - email_sequence_activity_log - email_sequence_activity_log_id - sort_order x-stoplight: id: gvp6wo5xaikti createEmailSequenceActivityLogLineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - email_sequence_activity_log_id - sort_order x-stoplight: id: w4wlmfp5jtbsy updateEmailSequenceActivityLogLineInput: properties: email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: x69sr6a80t18g batchEmailSequenceActivityLogLineInput: properties: email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_visible: description: Boolean value. type: boolean example: false sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ga34smksn20m2 EmailSequenceEnrolled: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri actor: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri email_sequence_activity_log: description: >- Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties. type: string format: uri email_sequence: description: >- Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_reason: description: 'Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished' type: integer example: 0 enum: - 0 - 1 - 2 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' entity_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 readOnly: true excluded_from_stats: description: Boolean value. type: boolean example: false lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' step_count: description: Whole natural number. type: integer format: int32 example: 1 step_index: description: '' type: integer format: int32 example: 1 entity_name: description: '' type: string example: string required: - is_delete_protected - id - application - email_sequence_activity_log - email_sequence - application_id - email_sequence_activity_log_id - email_sequence_id - entity_id - entity_type - start_time - step_count - entity_name x-stoplight: id: o44tdgfc64quu createEmailSequenceEnrolledInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_reason: description: 'Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished' type: integer example: 0 enum: - 0 - 1 - 2 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' excluded_from_stats: description: Boolean value. type: boolean example: false lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' required: - application_id - email_sequence_activity_log_id - email_sequence_id - start_time x-stoplight: id: d3p4wfo4broai updateEmailSequenceEnrolledInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_reason: description: 'Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished' type: integer example: 0 enum: - 0 - 1 - 2 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' excluded_from_stats: description: Boolean value. type: boolean example: false lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' x-stoplight: id: gsryqwrfuqfum batchEmailSequenceEnrolledInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_reason: description: 'Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished' type: integer example: 0 enum: - 0 - 1 - 2 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' excluded_from_stats: description: Boolean value. type: boolean example: false lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' id: description: ID of object to update. type: string format: uuid x-stoplight: id: ukb6qp5c1r7iz EmailTemplate: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_template_folder: description: >- Relation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateFolder' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri body: description: Html text input field. type: string example: string email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: String value. type: string example: string type: description: 'Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailTemplateSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailTemplateSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateSharingClientRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - name - owner_id - subject - type x-stoplight: id: 6nftqq1noleij createEmailTemplateInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true body: description: Html text input field. type: string example: string email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: String value. type: string example: string type: description: 'Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailTemplateSharingSalesUnitRelation, see: 'createEmailTemplateSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailTemplateSharingClientRelation, see: 'createEmailTemplateSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - name - owner_id - subject - type x-stoplight: id: 6mkoye58qr7ry updateEmailTemplateInput: properties: body: description: Html text input field. type: string example: string email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: String value. type: string example: string type: description: 'Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailTemplateSharingSalesUnitRelation, see: 'updateEmailTemplateSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailTemplateSharingClientRelation, see: 'updateEmailTemplateSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 43cbop3208phv batchEmailTemplateInput: properties: body: description: Html text input field. type: string example: string email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 subject: description: String value. type: string example: string type: description: 'Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to EmailTemplateSharingSalesUnitRelation, see: 'updateEmailTemplateSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to EmailTemplateSharingClientRelation, see: 'updateEmailTemplateSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6oay8qzilm5m2 EmailTemplateFolder: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true parent_email_template_folder: description: >- Relation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateFolder' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - name x-stoplight: id: bpis6toss4ex0 createEmailTemplateFolderInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string parent_email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name x-stoplight: id: 6jukyxxzjxhrq updateEmailTemplateFolderInput: properties: name: description: Name of the entity and its default text representation. type: string example: string parent_email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: nylpayhf3tabs batchEmailTemplateFolderInput: properties: name: description: Name of the entity and its default text representation. type: string example: string parent_email_template_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: d46dw2es1m3kh EmailTemplateSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri email_template: description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - email_template - client_id - email_template_id x-stoplight: id: vbkd9pqhc7tx5 createEmailTemplateSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - email_template_id x-stoplight: id: vv3v8urtqvnnn updateEmailTemplateSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: z35u0nsl7y5hq batchEmailTemplateSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: klriypzhyo2s2 EmailTemplateSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_template: description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - email_template - unit - email_template_id - unit_id x-stoplight: id: mkukqctcdvh32 createEmailTemplateSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - email_template_id - unit_id x-stoplight: id: fq24mp4r457yk updateEmailTemplateSharingSalesUnitRelationInput: properties: email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: cceoy3qsc1x58 batchEmailTemplateSharingSalesUnitRelationInput: properties: email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5g7glhhjrtkk4 Entity: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true entity_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true table_ex: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true table_data_ex: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true default_view_field_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true abstract_entity_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true entity_type: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true preference_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true allows_multiple_relation: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true has_draft: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true access_mode: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true icon: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true is_deleted: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true settings: description: Field containing json. type: object name_singular: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name_plural: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string required: - is_delete_protected - id - default_view_field_id - abstract_entity_id - entity_type - preference_order - has_draft - access_mode - icon x-stoplight: id: poihrl7zgimxv EntityFitness: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri oppty_type: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 indicator_relations: description: Relations to EntityFitnessIndicators. type: array items: description: >- Relation to EntityFitnessIndicator. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EntityFitnessIndicator' object for properties. type: string format: uri entity_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 required: - is_delete_protected - id - entity_type_id - entity_type x-stoplight: id: ryti57e693wtc createEntityFitnessInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 indicator_relations: description: Relations to EntityFitnessIndicators. type: array items: description: >- Relation to EntityFitnessIndicator, see: 'createEntityFitnessIndicatorInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: zcy2thc2yiw8v updateEntityFitnessInput: properties: revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 indicator_relations: description: Relations to EntityFitnessIndicators. type: array items: description: >- Relation to EntityFitnessIndicator, see: 'updateEntityFitnessIndicatorInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 87ohaupil3ufd batchEntityFitnessInput: properties: revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 indicator_relations: description: Relations to EntityFitnessIndicators. type: array items: description: >- Relation to EntityFitnessIndicator, see: 'updateEntityFitnessIndicatorInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 8c23m43y0vzp4 EntityFitnessIndicator: properties: description: description: String value. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_fitness: description: >- Relation to EntityFitness. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EntityFitness' object for properties. type: string format: uri description_use_lang: description: Boolean value. type: boolean example: false entity_fitness_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 how_to_fix: description: String value. type: string example: string how_to_fix_use_lang: description: Boolean value. type: boolean example: false is_enabled: description: Boolean value. type: boolean example: false name: description: String value. type: string example: string name_use_lang: description: Boolean value. type: boolean example: false settings: description: '' type: string format: binary example: blob type: description: >- Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - entity_fitness - description - description_use_lang - entity_fitness_id - how_to_fix - how_to_fix_use_lang - is_enabled - name - name_use_lang - settings - type x-stoplight: id: zqitgm6x10swm createEntityFitnessIndicatorInput: properties: description: description: String value. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true description_use_lang: description: Boolean value. type: boolean example: false entity_fitness_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 how_to_fix: description: String value. type: string example: string how_to_fix_use_lang: description: Boolean value. type: boolean example: false is_enabled: description: Boolean value. type: boolean example: false name: description: String value. type: string example: string name_use_lang: description: Boolean value. type: boolean example: false settings: description: '' type: string format: binary example: blob type: description: >- Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - description - description_use_lang - entity_fitness_id - how_to_fix - how_to_fix_use_lang - is_enabled - name - name_use_lang - settings - type x-stoplight: id: 0fgzp870bc7ob updateEntityFitnessIndicatorInput: properties: description: description: String value. type: string example: string description_use_lang: description: Boolean value. type: boolean example: false entity_fitness_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 how_to_fix: description: String value. type: string example: string how_to_fix_use_lang: description: Boolean value. type: boolean example: false is_enabled: description: Boolean value. type: boolean example: false name: description: String value. type: string example: string name_use_lang: description: Boolean value. type: boolean example: false settings: description: '' type: string format: binary example: blob type: description: >- Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: pyrc2i3c8fliw batchEntityFitnessIndicatorInput: properties: description: description: String value. type: string example: string description_use_lang: description: Boolean value. type: boolean example: false entity_fitness_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 how_to_fix: description: String value. type: string example: string how_to_fix_use_lang: description: Boolean value. type: boolean example: false is_enabled: description: Boolean value. type: boolean example: false name: description: String value. type: string example: string name_use_lang: description: Boolean value. type: boolean example: false settings: description: '' type: string format: binary example: blob type: description: >- Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 256n2doifd8aa EntityHealth: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 is_enabled: description: Boolean value. type: boolean example: false last_recalculation: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 settings: description: '' type: string format: binary example: blob calculation_progress: description: '' type: integer format: int32 example: 1 required: - is_delete_protected - id - entity_type - is_enabled - settings x-stoplight: id: 6zql1lvf3zlvt createEntityHealthInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true is_enabled: description: Boolean value. type: boolean example: false last_recalculation: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_enabled x-stoplight: id: nqpzwup7zwe2x updateEntityHealthInput: properties: is_enabled: description: Boolean value. type: boolean example: false last_recalculation: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 settings: description: '' type: string format: binary example: blob x-stoplight: id: zzm2g4ruoesmv batchEntityHealthInput: properties: is_enabled: description: Boolean value. type: boolean example: false last_recalculation: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 settings: description: '' type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: 9eba6soaj0oa5 EntityScoring: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 is_enabled: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Entity scoring definition in json format. type: object sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - entity_type - is_enabled - name - settings - sort_order x-stoplight: id: sn10uqc94vgyj createEntityScoringInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 is_enabled: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Entity scoring definition in json format. type: object sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - entity_type - is_enabled - name - settings - sort_order x-stoplight: id: 2a71qt4xj7h3q updateEntityScoringInput: properties: is_enabled: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Entity scoring definition in json format. type: object sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: f0poidthf1bna batchEntityScoringInput: properties: is_enabled: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Entity scoring definition in json format. type: object sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: r5w8733jq8as3 Field: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_name: description: >- Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...) type: string example: string readOnly: true api_name: description: Immutable and generated name. This name is used for integrations. type: string example: string name: description: User friendly name for field. type: string example: string use_lang: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 column_name: description: Simple text input field. type: string example: string column_source: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true relation_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string relation_with_entity_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string shared_with_field_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 system_type: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true type_id: description: >- Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url type: string example: string composite_field_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: Optional custom data set id can be set. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 parent_data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 calc_formula: description: Calculated formula used for fields which supports calculation. type: string example: string default_value: description: A default value for field. type: string example: string sequence_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 system_required: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true is_published: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true system_readonly: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: boolean example: false readOnly: true use_in_global_search: description: If this field is allowed in global search. type: boolean example: false settings: description: Field containing json. type: object is_unique: description: >- If true, then there will be an API validation if value of entity is unique. type: boolean example: false readOnly: true data_set: description: >- 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. type: string format: uri sequence_pattern: description: A sequence pattern used for sequence type of field. type: string example: string lookup: description: Lookup field definition. type: object rollup: description: Rollup field definition. type: object options: description: '' type: object advanced_formula: description: Advanced calculated formula type: object source_field_id: description: '' type: string example: string source_type_id: description: '' type: string example: string use_in_interface_preview: description: '' type: boolean example: false translated_name: description: '' type: string example: string field_permissions: description: >- 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. type: string format: uri original_dataset_field_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name_translations: description: '' type: string format: binary example: blob name_translated: description: '' type: string example: string primitive_type: description: '' type: string example: string is_available_for_webresource: description: '' type: boolean example: false is_available_for_advanced_formula: description: '' type: boolean example: false required: - is_delete_protected - has_draft - id - entity_name - name - type_id - data_set - source_field_id - source_type_id - use_in_interface_preview - translated_name - field_permissions - name_translations - name_translated - primitive_type - is_available_for_webresource - is_available_for_advanced_formula x-stoplight: id: 10nlmruuf4t57 createFieldInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_name: description: >- Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...) type: string example: string readOnly: true name: description: User friendly name for field. type: string example: string type_id: description: >- Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url type: string example: string data_set_id: description: Optional custom data set id can be set. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 calc_formula: description: Calculated formula used for fields which supports calculation. type: string example: string default_value: description: A default value for field. type: string example: string is_unique: description: >- If true, then there will be an API validation if value of entity is unique. type: boolean example: false readOnly: true name_translations: description: '' type: string format: binary example: blob required: - entity_name - name - type_id - name_translations x-stoplight: id: 5nges6ty9cd5a updateFieldInput: properties: name: description: User friendly name for field. type: string example: string calc_formula: description: Calculated formula used for fields which supports calculation. type: string example: string default_value: description: A default value for field. type: string example: string name_translations: description: '' type: string format: binary example: blob x-stoplight: id: kc95667uz7yml batchFieldInput: properties: name: description: User friendly name for field. type: string example: string calc_formula: description: Calculated formula used for fields which supports calculation. type: string example: string default_value: description: A default value for field. type: string example: string name_translations: description: '' type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: 76s9xhfsd6gsp FieldPermission: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true field: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri master_right: description: >- Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties. type: string format: uri field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 permission_level: description: 'Integer enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - has_draft - id - field - master_right - field_id - master_right_id x-stoplight: id: rj2qapftidt29 createFieldPermissionInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 master_right_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 permission_level: description: 'Integer enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - field_id - master_right_id x-stoplight: id: vqhkpntn0fl4i updateFieldPermissionInput: properties: permission_level: description: 'Integer enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: uy3c1j81ka4zz batchFieldPermissionInput: properties: permission_level: description: 'Integer enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 808ygbx2i0r87 FieldSequence: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true pattern: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string required: - is_delete_protected - id - pattern x-stoplight: id: b5tbi8w4kuylz Forecast: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true field: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri pipeline: description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. type: string format: uri readOnly: true end_date: description: Date information. type: string format: date example: '2019-01-01' readOnly: true field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true settings: description: Field containing json. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) type: integer example: 1 enum: - 1 - 2 start_date: description: Date information. type: string format: date example: '2019-01-01' readOnly: true type: description: Field containing json. type: object readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 shared_clients: description: '' type: array items: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri shared_units: description: '' type: array items: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri required: - is_delete_protected - id - field - owner - pipeline - end_date - field_id - name - owner_id - pipeline_id - settings - start_date - type - shared_clients - shared_units x-stoplight: id: nsl2qslf975qj createForecastInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 shared_clients: description: '' type: array items: description: >- Relation to Client, see: 'createClientInput' object for properties. type: object properties: id: type: string format: uri shared_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'createSalesUnitInput' object for properties. type: object properties: id: type: string format: uri required: - name - owner_id - settings - shared_clients - shared_units x-stoplight: id: 44dl8a2k80ii1 updateForecastInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 shared_clients: description: '' type: array items: description: >- Relation to Client, see: 'updateClientInput' object for properties. type: object properties: id: type: string format: uri shared_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: pmam6vhohlszh batchForecastInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 shared_clients: description: '' type: array items: description: >- Relation to Client, see: 'updateClientInput' object for properties. type: object properties: id: type: string format: uri shared_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 23h09nnq5mbxx FormView: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type: description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. type: string format: uri contact_type: description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. type: string format: uri lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri oppty_type: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 hidden_item_ids: description: Ids of fields hidden on the form type: object item_colors: description: Field containing json. type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 entity_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to FormViewSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormViewSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to FormViewSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormViewSharingClientRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - hidden_item_ids - item_colors - name - owner_id - entity_type_id x-stoplight: id: ugruk0vyyy5eh createFormViewInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 hidden_item_ids: description: Ids of fields hidden on the form type: object item_colors: description: Field containing json. type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to FormViewSharingSalesUnitRelation, see: 'createFormViewSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to FormViewSharingClientRelation, see: 'createFormViewSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri required: - hidden_item_ids - item_colors - name - owner_id x-stoplight: id: zo71w7krxkwku updateFormViewInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 hidden_item_ids: description: Ids of fields hidden on the form type: object item_colors: description: Field containing json. type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to FormViewSharingSalesUnitRelation, see: 'updateFormViewSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to FormViewSharingClientRelation, see: 'updateFormViewSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: nzqojnkcnl9js batchFormViewInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 hidden_item_ids: description: Ids of fields hidden on the form type: object item_colors: description: Field containing json. type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to FormViewSharingSalesUnitRelation, see: 'updateFormViewSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to FormViewSharingClientRelation, see: 'updateFormViewSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: f7edprzn9mjec FormViewSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri form_view: description: >- Relation to FormView. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormView' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - form_view - client_id - form_view_id x-stoplight: id: nmjp2jit6ii60 createFormViewSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - form_view_id x-stoplight: id: 40vvlqcfiotzm updateFormViewSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: qry8ionuym8c0 batchFormViewSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5fdwobbsz5o1d FormViewSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_view: description: >- Relation to FormView. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormView' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - form_view - unit - form_view_id - unit_id x-stoplight: id: 5jhbf53qozf6l createFormViewSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - form_view_id - unit_id x-stoplight: id: c36jno3puaz51 updateFormViewSharingSalesUnitRelationInput: properties: form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: uwpm3a3y4m3r6 batchFormViewSharingSalesUnitRelationInput: properties: form_view_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: kxte5o6b4jri9 GhostContact: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - name x-stoplight: id: zzbhbe3wl9t5d createGhostContactInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name x-stoplight: id: tgst5x5yd1x2a updateGhostContactInput: properties: name: description: Name of the entity and its default text representation. type: string example: string position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: dl4ynzih0mk5g batchGhostContactInput: properties: name: description: Name of the entity and its default text representation. type: string example: string position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: q6487mlt3tl0c GhostContactAccountAccountRoleRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_role: description: >- Relation to AccountRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRole' object for properties. type: string format: uri ghost_contact_account_relation: description: >- Relation to GhostContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContactAccountRelation' object for properties. type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 ghost_contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account_role - ghost_contact_account_relation - account_role_id - ghost_contact_account_relation_id x-stoplight: id: 38gv5kfc3h32s createGhostContactAccountAccountRoleRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_contact_account_relation: description: >- Relation to GhostContactAccountRelation, see: 'createGhostContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 ghost_contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - ghost_contact_account_relation - account_role_id - ghost_contact_account_relation_id x-stoplight: id: w6h03u2jamzw8 updateGhostContactAccountAccountRoleRelationInput: properties: ghost_contact_account_relation: description: >- Relation to GhostContactAccountRelation, see: 'updateGhostContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 ghost_contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: f3dvl4auqnxd8 batchGhostContactAccountAccountRoleRelationInput: properties: ghost_contact_account_relation: description: >- Relation to GhostContactAccountRelation, see: 'updateGhostContactAccountRelationInput' object for properties. type: object properties: id: type: string format: uri account_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 ghost_contact_account_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: hoa12351u19kp GhostContactAccountRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri ghost_contact: description: >- Relation to GhostContact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContact' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to GhostContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContactAccountAccountRoleRelation' object for properties. type: string format: uri required: - is_delete_protected - id - account - ghost_contact - account_id - ghost_contact_id x-stoplight: id: v37xu2nlmxtwl createGhostContactAccountRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_contact: description: >- Relation to GhostContact, see: 'createGhostContactInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to GhostContactAccountAccountRoleRelation, see: 'createGhostContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri required: - ghost_contact - account_id - ghost_contact_id x-stoplight: id: u9uduczg0xlov updateGhostContactAccountRelationInput: properties: ghost_contact: description: >- Relation to GhostContact, see: 'updateGhostContactInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to GhostContactAccountAccountRoleRelation, see: 'updateGhostContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 5dinbxnr8py5g batchGhostContactAccountRelationInput: properties: ghost_contact: description: >- Relation to GhostContact, see: 'updateGhostContactInput' object for properties. type: object properties: id: type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 comment: description: Simple text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_assistant: description: Boolean value. type: boolean example: false is_sibling: description: Boolean value. type: boolean example: false position: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_roles: description: Relations to AccountRoles. type: array items: description: >- Relation to GhostContactAccountAccountRoleRelation, see: 'updateGhostContactAccountAccountRoleRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 30rf0cx2i79k8 GhostLeadOpptyContactRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_contact: description: >- Relation to GhostContact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContact' object for properties. type: string format: uri lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri comment: description: Multi-line text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to GhostLeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostLeadOpptyContactSalesRoleRelation' object for properties. type: string format: uri required: - is_delete_protected - id - ghost_contact - ghost_contact_id - lead_oppty_id x-stoplight: id: hxcyqr3oa4v89 createGhostLeadOpptyContactRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_contact: description: >- Relation to GhostContact, see: 'createGhostContactInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'createLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'createGhostLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri required: - ghost_contact - ghost_contact_id - lead_oppty_id x-stoplight: id: ru9aqg4e1j641 updateGhostLeadOpptyContactRelationInput: properties: ghost_contact: description: >- Relation to GhostContact, see: 'updateGhostContactInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'updateGhostLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: lwj2mjs2qkhse batchGhostLeadOpptyContactRelationInput: properties: ghost_contact: description: >- Relation to GhostContact, see: 'updateGhostContactInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string ghost_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'updateGhostLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: h0etraruodqzo GhostLeadOpptyContactSalesRoleRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_lead_oppty_contact_relation: description: >- Relation to GhostLeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostLeadOpptyContactRelation' object for properties. type: string format: uri sales_role: description: >- Relation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties. type: string format: uri ghost_lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - ghost_lead_oppty_contact_relation - sales_role - ghost_lead_oppty_contact_relation_id - sales_role_id x-stoplight: id: hqr3loueuyibh createGhostLeadOpptyContactSalesRoleRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true ghost_lead_oppty_contact_relation: description: >- Relation to GhostLeadOpptyContactRelation, see: 'createGhostLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri ghost_lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - ghost_lead_oppty_contact_relation - ghost_lead_oppty_contact_relation_id - sales_role_id x-stoplight: id: 6nb3m4pv5ckdr updateGhostLeadOpptyContactSalesRoleRelationInput: properties: ghost_lead_oppty_contact_relation: description: >- Relation to GhostLeadOpptyContactRelation, see: 'updateGhostLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri ghost_lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: tvbi7ekelefo6 batchGhostLeadOpptyContactSalesRoleRelationInput: properties: ghost_lead_oppty_contact_relation: description: >- Relation to GhostLeadOpptyContactRelation, see: 'updateGhostLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri ghost_lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: s11745vgetmst ImportMappingMask: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 mapping: description: Import mapping mask/relation_types in json format type: object name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 relation_types: description: Import mapping mask/relation_types in json format type: object share_mode: description: >- Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_clients: description: '' type: array items: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri sharing_units: description: '' type: array items: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri required: - is_delete_protected - id - owner - entity_type - mapping - name - owner_id x-stoplight: id: fa08wafn19y7p createImportMappingMaskInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 mapping: description: Import mapping mask/relation_types in json format type: object name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 relation_types: description: Import mapping mask/relation_types in json format type: object share_mode: description: >- Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_clients: description: '' type: array items: description: >- Relation to Client, see: 'createClientInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'createSalesUnitInput' object for properties. type: object properties: id: type: string format: uri required: - entity_type - mapping - name - owner_id x-stoplight: id: 4w3h8sk9z8498 updateImportMappingMaskInput: properties: entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 mapping: description: Import mapping mask/relation_types in json format type: object name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 relation_types: description: Import mapping mask/relation_types in json format type: object share_mode: description: >- Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_clients: description: '' type: array items: description: >- Relation to Client, see: 'updateClientInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: f3q2q0pxpsji2 batchImportMappingMaskInput: properties: entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string entity_type: description: >- Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 mapping: description: Import mapping mask/relation_types in json format type: object name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 relation_types: description: Import mapping mask/relation_types in json format type: object share_mode: description: >- Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers type: integer example: 0 enum: - 0 - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_clients: description: '' type: array items: description: >- Relation to Client, see: 'updateClientInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: '' type: array items: description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 1huw1mm1gpz6i InterfacePreview: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type: description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. type: string format: uri appointment_type: description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. type: string format: uri contact_type: description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. type: string format: uri custom_entity_type: description: >- Relation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties. type: string format: uri lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri oppty_type: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri product_type: description: >- Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties. type: string format: uri project_type: description: >- Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties. type: string format: uri quote_type: description: >- Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. type: string format: uri task_type: description: >- Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. type: string format: uri account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true card_field_ids: description: '' type: object charts: description: Field containing json. type: object contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true custom_entity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true detail_tabs: description: Field containing json. type: object detail_widgets: description: Field containing json. type: object field_ids: description: '' type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 entity_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 required: - is_delete_protected - has_draft - id - card_field_ids - charts - detail_tabs - detail_widgets - field_ids - entity_type_id - entity_type x-stoplight: id: joycuqkfaiv3l createInterfacePreviewInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true card_field_ids: description: '' type: object charts: description: Field containing json. type: object contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true custom_entity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true detail_tabs: description: Field containing json. type: object detail_widgets: description: Field containing json. type: object field_ids: description: '' type: object lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 entity_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true required: - card_field_ids - charts - detail_tabs - detail_widgets - field_ids - entity_type_id x-stoplight: id: h1ofd0fseidmu updateInterfacePreviewInput: properties: card_field_ids: description: '' type: object charts: description: Field containing json. type: object detail_tabs: description: Field containing json. type: object detail_widgets: description: Field containing json. type: object field_ids: description: '' type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: kipx9i00vwas1 batchInterfacePreviewInput: properties: card_field_ids: description: '' type: object charts: description: Field containing json. type: object detail_tabs: description: Field containing json. type: object detail_widgets: description: Field containing json. type: object field_ids: description: '' type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5494w5put8067 Lead: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties. type: string format: uri description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' lead_source: description: >- 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. type: string format: uri lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri reason_of_close: description: >- 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. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri is_archived: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 primary_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri primary_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyAccountRelation' object for properties. type: string format: uri status: description: 'Integer enum value: 1 - Open, 2 - Lost, 4 - Qualified' type: integer example: 1 enum: - 1 - 2 - 4 readOnly: true sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingClientRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri qualify_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' days_in_step: description: '' type: integer format: int32 example: 1 is_favorite: description: '' type: boolean example: false lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' formatted_name: description: '' type: string example: string scoring: description: '' type: object modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - lead_type - step - unit - name - table_name - status - days_in_step - is_favorite - formatted_name x-stoplight: id: 8q5vymm6p8civ createLeadInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'createTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' is_archived: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'createLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'createLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'createLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - name x-stoplight: id: ox7no239z6lns updateLeadInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' is_archived: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' x-stoplight: id: 1ehqdvoozxf02 batchLeadInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' is_archived: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' id: description: ID of object to update. type: string format: uuid x-stoplight: id: 62dv6v2o5biy2 LeadOppty: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true required: - is_delete_protected - id x-stoplight: id: bl13em2de6vuh LeadOpptyAccountRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - account_id - is_primary - lead_oppty_id x-stoplight: id: txdvjushq4woa createLeadOpptyAccountRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_id - is_primary - lead_oppty_id x-stoplight: id: mcqpfbnsgmcfl updateLeadOpptyAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: vtp8ted33gjq8 batchLeadOpptyAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: sxacebcl6vgc5 LeadOpptyContactGroupRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 group_position: description: Field containing json. type: object lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color - group_position - lead_oppty_id - name x-stoplight: id: j12wv8piq9ba3 createLeadOpptyContactGroupRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 group_position: description: Field containing json. type: object lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color - group_position - lead_oppty_id - name x-stoplight: id: 31al78d6wty76 updateLeadOpptyContactGroupRelationInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 group_position: description: Field containing json. type: object lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: gir148y02w48u batchLeadOpptyContactGroupRelationInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 group_position: description: Field containing json. type: object lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: c2auyo3en1goz LeadOpptyContactRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to LeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactSalesRoleRelation' object for properties. type: string format: uri required: - is_delete_protected - id - contact - contact_id - is_primary - lead_oppty_id x-stoplight: id: e52jw2qo5ct0h createLeadOpptyContactRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'createLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to LeadOpptyContactSalesRoleRelation, see: 'createLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri required: - contact_id - is_primary - lead_oppty_id x-stoplight: id: m0p5wvsns5377 updateLeadOpptyContactRelationInput: properties: lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to LeadOpptyContactSalesRoleRelation, see: 'updateLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: g7emd5lm6i343 batchLeadOpptyContactRelationInput: properties: lead_oppty_contact_group_relation: description: >- Relation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties. type: object properties: id: type: string format: uri comment: description: Multi-line text input field. type: string example: string contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_contact_group_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 position_in_group: description: Field containing json. type: object relationship: description: >- Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to LeadOpptyContactSalesRoleRelation, see: 'updateLeadOpptyContactSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 5mj7gvimu69qz LeadOpptyContactSalesRoleRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_oppty_contact_relation: description: >- Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties. type: string format: uri sales_role: description: >- Relation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties. type: string format: uri lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - sales_role - sales_role_id x-stoplight: id: 88c6ak4an1jgh createLeadOpptyContactSalesRoleRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_oppty_contact_relation: description: >- Relation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - sales_role_id x-stoplight: id: md12ouon3sjul updateLeadOpptyContactSalesRoleRelationInput: properties: lead_oppty_contact_relation: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: eulnrtkuveaxy batchLeadOpptyContactSalesRoleRelationInput: properties: lead_oppty_contact_relation: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri lead_oppty_contact_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: zns9n83n7x8qi LeadOpptyDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - data_id - data_set_id - lead_oppty_id x-stoplight: id: n96wq3fnryyr7 LeadOpptyKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove type: integer example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - unit - kpi - lead_oppty_id - unit_id x-stoplight: id: sk2ipj1iev0ir createLeadOpptyKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove type: integer example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - kpi - lead_oppty_id - unit_id x-stoplight: id: tjvusa1bbf4zk updateLeadOpptyKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove type: integer example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: dt1ruosyf2mjm batchLeadOpptyKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove type: integer example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: fauk4ux01v280 LeadOpptySharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - client_id - lead_oppty_id x-stoplight: id: bvd8zjbb5rwqu createLeadOpptySharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - lead_oppty_id x-stoplight: id: 3lpjhhv74iqv1 updateLeadOpptySharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 0dm20l68iycz1 batchLeadOpptySharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 839557oh0h7t8 LeadOpptySharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - unit - lead_oppty_id - unit_id x-stoplight: id: jgpjhfwh9vs1n createLeadOpptySharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - lead_oppty_id - unit_id x-stoplight: id: qxzv6ma440qyn updateLeadOpptySharingSalesUnitRelationInput: properties: lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: sg77ap48hy6dw batchLeadOpptySharingSalesUnitRelationInput: properties: lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 8cw3z1lb0ay7r LeadOpptyStepCheckListRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment: description: >- Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri cloud_object: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri email: description: >- 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. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri note: description: >- Relation to Note. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Note' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri step_checklist: description: >- Relation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties. type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_checked: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - step_checklist - step_checklist_id x-stoplight: id: v0pa5fc9r6ikv createLeadOpptyStepCheckListRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cloud_object: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri note: description: 'Relation to Note, see: ''createNoteInput'' object for properties.' type: object properties: id: type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_checked: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - step_checklist_id x-stoplight: id: pzdvd8ffn0q96 updateLeadOpptyStepCheckListRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri note: description: 'Relation to Note, see: ''updateNoteInput'' object for properties.' type: object properties: id: type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_checked: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 9p0hfoa77zrf1 batchLeadOpptyStepCheckListRelationInput: properties: cloud_object: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri note: description: 'Relation to Note, see: ''updateNoteInput'' object for properties.' type: object properties: id: type: string format: uri activity_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_checked: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 0n75bgxuof1rr LeadProcess: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' lead_types: description: '' type: array items: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri required: - is_delete_protected - id - name - steps - lead_types x-stoplight: id: 0p5mk0q8w1k6o createLeadProcessInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' required: - name - steps x-stoplight: id: nt61anvmzk9x6 updateLeadProcessInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' x-stoplight: id: hrwzgden10jr8 batchLeadProcessInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6js4qco1f1d19 LeadType: properties: id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_process: description: >- Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties. type: string format: uri form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false form_lost_api: description: Form definition in json format. type: object required: - id - lead_process - form_lost_enabled - is_readonly - lead_process_id - name - has_draft - is_delete_protected - form_edit_api - form_lost_api x-stoplight: id: 7erhmenojujba createLeadTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - form_lost_enabled - is_readonly - lead_process_id - name x-stoplight: id: xicvg8rlg8jwu updateLeadTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: z2vunytx27w6j batchLeadTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: dvpwdi5y0ku2y MasterRight: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true access_account_relation_types: description: Controls access to resource. type: boolean example: false access_accounts: description: Controls access to resource. type: boolean example: false access_appointment_scheduler: description: Controls access to resource. type: boolean example: false access_appointment_scheduler_management: description: Controls access to resource. type: boolean example: false access_approval_processes: description: Controls access to resource. type: boolean example: false access_approval_processes_management: description: Controls access to resource. type: boolean example: false access_approvals: description: Controls access to resource. type: boolean example: false access_archive: description: Controls access to resource. type: boolean example: false access_audit: description: Controls access to resource. type: boolean example: false access_audit_log: description: Controls access to resource. type: boolean example: false access_bulk_update: description: Controls access to resource. type: boolean example: false access_calling: description: Controls access to resource. type: boolean example: false access_calling_company_phone: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_calling_purchase_phone: description: Controls access to resource. type: boolean example: false access_company_emails: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_contacts: description: Controls access to resource. type: boolean example: false access_document_management: description: Controls access to resource. type: boolean example: false access_document_management_company: description: Controls access to resource. type: boolean example: false access_document_management_record: description: Controls access to resource. type: boolean example: false access_entity_account: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_account_delete: description: Controls access to resource. type: boolean example: false access_entity_account_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_account_private: description: Controls access to resource. type: boolean example: false access_entity_account_tag_create: description: Controls access to resource. type: boolean example: false access_entity_account_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_appointment: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_appointment_delete: description: Controls access to resource. type: boolean example: false access_entity_appointment_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_contact_delete: description: Controls access to resource. type: boolean example: false access_entity_contact_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact_private: description: Controls access to resource. type: boolean example: false access_entity_contact_tag_create: description: Controls access to resource. type: boolean example: false access_entity_contact_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_dashboard: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_dashboard_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_email_content_share_mode: description: 'Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly' type: integer example: 0 enum: - 0 - 1 - 2 access_entity_email_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_sequence: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_email_template: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_email_template_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_forecast: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_forecast_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_form_view: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_form_view_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_lead: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_lead_delete: description: Controls access to resource. type: boolean example: false access_entity_lead_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_lead_private: description: Controls access to resource. type: boolean example: false access_entity_lead_tag_create: description: Controls access to resource. type: boolean example: false access_entity_lead_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_oppty: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_oppty_delete: description: Controls access to resource. type: boolean example: false access_entity_oppty_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_oppty_private: description: Controls access to resource. type: boolean example: false access_entity_oppty_tag_create: description: Controls access to resource. type: boolean example: false access_entity_pipeline: description: >- Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments type: integer example: 0 enum: - 0 - 1 - 2 - 3 access_entity_process: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_profile: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_profile_default_screen_profiles: description: Field containing json. type: object access_entity_profile_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_project: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_project_delete: description: Controls access to resource. type: boolean example: false access_entity_project_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_project_private: description: Controls access to resource. type: boolean example: false access_entity_project_tag_create: description: Controls access to resource. type: boolean example: false access_entity_quote: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_quote_delete: description: Controls access to resource. type: boolean example: false access_entity_quote_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_quote_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_report: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_report_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_report_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_report_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_target: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_target_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_target_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_task: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_task_delete: description: Controls access to resource. type: boolean example: false access_entity_task_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_task_unassigned: description: Controls access to resource. type: boolean example: false access_export: description: Controls access to resource. type: boolean example: false access_feeds: description: Controls access to resource. type: boolean example: false access_foreign_currencies: description: Controls access to resource. type: boolean example: false access_form_and_fields: description: Controls access to resource. type: boolean example: false access_global_settings: description: Controls access to resource. type: boolean example: false access_home_screen: description: Controls access to resource. type: boolean example: false access_import: description: Controls access to resource. type: boolean example: false access_insights: description: Controls access to resource. type: boolean example: false access_leads: description: Controls access to resource. type: boolean example: false access_online_forms: description: Controls access to resource. type: boolean example: false access_online_forms_management: description: Controls access to resource. type: boolean example: false access_opportunity: description: Controls access to resource. type: boolean example: false access_pipeline_configuration: description: Controls access to resource. type: boolean example: false access_print: description: Controls access to resource. type: boolean example: false access_products_services: description: Controls access to resource. type: boolean example: false access_projects: description: Controls access to resource. type: boolean example: false access_quotes: description: Controls access to resource. type: boolean example: false access_sales_roles: description: Controls access to resource. type: boolean example: false access_security: description: Controls access to resource. type: boolean example: false access_units: description: Controls access to resource. type: boolean example: false access_user_and_roles: description: Controls access to resource. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 allowed_pipelines: description: Relations to Pipelines. type: array items: description: >- Relation to AllowedPipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedPipeline' object for properties. type: string format: uri allowed_lead_types: description: Relations to LeadTypes. type: array items: description: >- Relation to AllowedLeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedLeadType' object for properties. type: string format: uri allowed_quote_types: description: Relations to QuoteTypes. type: array items: description: >- Relation to AllowedQuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedQuoteType' object for properties. type: string format: uri allowed_account_types: description: Relations to AccountTypes. type: array items: description: >- Relation to AllowedAccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedAccountType' object for properties. type: string format: uri allowed_contact_types: description: Relations to ContactTypes. type: array items: description: >- Relation to AllowedContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedContactType' object for properties. type: string format: uri allowed_company_emails: description: Relations to CompanyEmails. type: array items: description: >- Relation to AllowedCompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyEmail' object for properties. type: string format: uri allowed_company_phones: description: Relations to Phones. type: array items: description: >- Relation to AllowedCompanyPhone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyPhone' object for properties. type: string format: uri custom_entities: description: '' type: string format: binary example: blob required: - is_delete_protected - id - name x-stoplight: id: 6agqqpl15dk9a createMasterRightInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true access_account_relation_types: description: Controls access to resource. type: boolean example: false access_accounts: description: Controls access to resource. type: boolean example: false access_appointment_scheduler: description: Controls access to resource. type: boolean example: false access_appointment_scheduler_management: description: Controls access to resource. type: boolean example: false access_approval_processes: description: Controls access to resource. type: boolean example: false access_approval_processes_management: description: Controls access to resource. type: boolean example: false access_approvals: description: Controls access to resource. type: boolean example: false access_archive: description: Controls access to resource. type: boolean example: false access_audit: description: Controls access to resource. type: boolean example: false access_audit_log: description: Controls access to resource. type: boolean example: false access_bulk_update: description: Controls access to resource. type: boolean example: false access_calling: description: Controls access to resource. type: boolean example: false access_calling_company_phone: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_calling_purchase_phone: description: Controls access to resource. type: boolean example: false access_company_emails: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_contacts: description: Controls access to resource. type: boolean example: false access_document_management: description: Controls access to resource. type: boolean example: false access_document_management_company: description: Controls access to resource. type: boolean example: false access_document_management_record: description: Controls access to resource. type: boolean example: false access_entity_account: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_account_delete: description: Controls access to resource. type: boolean example: false access_entity_account_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_account_private: description: Controls access to resource. type: boolean example: false access_entity_account_tag_create: description: Controls access to resource. type: boolean example: false access_entity_account_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_appointment: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_appointment_delete: description: Controls access to resource. type: boolean example: false access_entity_appointment_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_contact_delete: description: Controls access to resource. type: boolean example: false access_entity_contact_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact_private: description: Controls access to resource. type: boolean example: false access_entity_contact_tag_create: description: Controls access to resource. type: boolean example: false access_entity_contact_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_dashboard: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_dashboard_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_email_content_share_mode: description: 'Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly' type: integer example: 0 enum: - 0 - 1 - 2 access_entity_email_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_sequence: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_email_template: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_email_template_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_forecast: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_forecast_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_form_view: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_form_view_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_lead: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_lead_delete: description: Controls access to resource. type: boolean example: false access_entity_lead_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_lead_private: description: Controls access to resource. type: boolean example: false access_entity_lead_tag_create: description: Controls access to resource. type: boolean example: false access_entity_lead_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_oppty: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_oppty_delete: description: Controls access to resource. type: boolean example: false access_entity_oppty_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_oppty_private: description: Controls access to resource. type: boolean example: false access_entity_oppty_tag_create: description: Controls access to resource. type: boolean example: false access_entity_pipeline: description: >- Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments type: integer example: 0 enum: - 0 - 1 - 2 - 3 access_entity_process: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_profile: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_profile_default_screen_profiles: description: Field containing json. type: object access_entity_profile_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_project: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_project_delete: description: Controls access to resource. type: boolean example: false access_entity_project_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_project_private: description: Controls access to resource. type: boolean example: false access_entity_project_tag_create: description: Controls access to resource. type: boolean example: false access_entity_quote: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_quote_delete: description: Controls access to resource. type: boolean example: false access_entity_quote_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_quote_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_report: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_report_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_report_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_report_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_target: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_target_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_target_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_task: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_task_delete: description: Controls access to resource. type: boolean example: false access_entity_task_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_task_unassigned: description: Controls access to resource. type: boolean example: false access_export: description: Controls access to resource. type: boolean example: false access_feeds: description: Controls access to resource. type: boolean example: false access_foreign_currencies: description: Controls access to resource. type: boolean example: false access_form_and_fields: description: Controls access to resource. type: boolean example: false access_global_settings: description: Controls access to resource. type: boolean example: false access_home_screen: description: Controls access to resource. type: boolean example: false access_import: description: Controls access to resource. type: boolean example: false access_insights: description: Controls access to resource. type: boolean example: false access_leads: description: Controls access to resource. type: boolean example: false access_online_forms: description: Controls access to resource. type: boolean example: false access_online_forms_management: description: Controls access to resource. type: boolean example: false access_opportunity: description: Controls access to resource. type: boolean example: false access_pipeline_configuration: description: Controls access to resource. type: boolean example: false access_print: description: Controls access to resource. type: boolean example: false access_products_services: description: Controls access to resource. type: boolean example: false access_projects: description: Controls access to resource. type: boolean example: false access_quotes: description: Controls access to resource. type: boolean example: false access_sales_roles: description: Controls access to resource. type: boolean example: false access_security: description: Controls access to resource. type: boolean example: false access_units: description: Controls access to resource. type: boolean example: false access_user_and_roles: description: Controls access to resource. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 allowed_pipelines: description: Relations to Pipelines. type: array items: description: >- Relation to AllowedPipeline, see: 'createAllowedPipelineInput' object for properties. type: object properties: id: type: string format: uri allowed_lead_types: description: Relations to LeadTypes. type: array items: description: >- Relation to AllowedLeadType, see: 'createAllowedLeadTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_quote_types: description: Relations to QuoteTypes. type: array items: description: >- Relation to AllowedQuoteType, see: 'createAllowedQuoteTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_account_types: description: Relations to AccountTypes. type: array items: description: >- Relation to AllowedAccountType, see: 'createAllowedAccountTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_contact_types: description: Relations to ContactTypes. type: array items: description: >- Relation to AllowedContactType, see: 'createAllowedContactTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_company_emails: description: Relations to CompanyEmails. type: array items: description: >- Relation to AllowedCompanyEmail, see: 'createAllowedCompanyEmailInput' object for properties. type: object properties: id: type: string format: uri allowed_company_phones: description: Relations to Phones. type: array items: description: >- Relation to AllowedCompanyPhone, see: 'createAllowedCompanyPhoneInput' object for properties. type: object properties: id: type: string format: uri custom_entities: description: '' type: string format: binary example: blob required: - name x-stoplight: id: ax0y6exkcem89 updateMasterRightInput: properties: access_account_relation_types: description: Controls access to resource. type: boolean example: false access_accounts: description: Controls access to resource. type: boolean example: false access_appointment_scheduler: description: Controls access to resource. type: boolean example: false access_appointment_scheduler_management: description: Controls access to resource. type: boolean example: false access_approval_processes: description: Controls access to resource. type: boolean example: false access_approval_processes_management: description: Controls access to resource. type: boolean example: false access_approvals: description: Controls access to resource. type: boolean example: false access_archive: description: Controls access to resource. type: boolean example: false access_audit: description: Controls access to resource. type: boolean example: false access_audit_log: description: Controls access to resource. type: boolean example: false access_bulk_update: description: Controls access to resource. type: boolean example: false access_calling: description: Controls access to resource. type: boolean example: false access_calling_company_phone: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_calling_purchase_phone: description: Controls access to resource. type: boolean example: false access_company_emails: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_contacts: description: Controls access to resource. type: boolean example: false access_document_management: description: Controls access to resource. type: boolean example: false access_document_management_company: description: Controls access to resource. type: boolean example: false access_document_management_record: description: Controls access to resource. type: boolean example: false access_entity_account: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_account_delete: description: Controls access to resource. type: boolean example: false access_entity_account_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_account_private: description: Controls access to resource. type: boolean example: false access_entity_account_tag_create: description: Controls access to resource. type: boolean example: false access_entity_account_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_appointment: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_appointment_delete: description: Controls access to resource. type: boolean example: false access_entity_appointment_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_contact_delete: description: Controls access to resource. type: boolean example: false access_entity_contact_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact_private: description: Controls access to resource. type: boolean example: false access_entity_contact_tag_create: description: Controls access to resource. type: boolean example: false access_entity_contact_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_dashboard: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_dashboard_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_email_content_share_mode: description: 'Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly' type: integer example: 0 enum: - 0 - 1 - 2 access_entity_email_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_sequence: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_email_template: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_email_template_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_forecast: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_forecast_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_form_view: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_form_view_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_lead: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_lead_delete: description: Controls access to resource. type: boolean example: false access_entity_lead_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_lead_private: description: Controls access to resource. type: boolean example: false access_entity_lead_tag_create: description: Controls access to resource. type: boolean example: false access_entity_lead_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_oppty: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_oppty_delete: description: Controls access to resource. type: boolean example: false access_entity_oppty_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_oppty_private: description: Controls access to resource. type: boolean example: false access_entity_oppty_tag_create: description: Controls access to resource. type: boolean example: false access_entity_pipeline: description: >- Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments type: integer example: 0 enum: - 0 - 1 - 2 - 3 access_entity_process: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_profile: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_profile_default_screen_profiles: description: Field containing json. type: object access_entity_profile_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_project: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_project_delete: description: Controls access to resource. type: boolean example: false access_entity_project_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_project_private: description: Controls access to resource. type: boolean example: false access_entity_project_tag_create: description: Controls access to resource. type: boolean example: false access_entity_quote: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_quote_delete: description: Controls access to resource. type: boolean example: false access_entity_quote_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_quote_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_report: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_report_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_report_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_report_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_target: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_target_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_target_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_task: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_task_delete: description: Controls access to resource. type: boolean example: false access_entity_task_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_task_unassigned: description: Controls access to resource. type: boolean example: false access_export: description: Controls access to resource. type: boolean example: false access_feeds: description: Controls access to resource. type: boolean example: false access_foreign_currencies: description: Controls access to resource. type: boolean example: false access_form_and_fields: description: Controls access to resource. type: boolean example: false access_global_settings: description: Controls access to resource. type: boolean example: false access_home_screen: description: Controls access to resource. type: boolean example: false access_import: description: Controls access to resource. type: boolean example: false access_insights: description: Controls access to resource. type: boolean example: false access_leads: description: Controls access to resource. type: boolean example: false access_online_forms: description: Controls access to resource. type: boolean example: false access_online_forms_management: description: Controls access to resource. type: boolean example: false access_opportunity: description: Controls access to resource. type: boolean example: false access_pipeline_configuration: description: Controls access to resource. type: boolean example: false access_print: description: Controls access to resource. type: boolean example: false access_products_services: description: Controls access to resource. type: boolean example: false access_projects: description: Controls access to resource. type: boolean example: false access_quotes: description: Controls access to resource. type: boolean example: false access_sales_roles: description: Controls access to resource. type: boolean example: false access_security: description: Controls access to resource. type: boolean example: false access_units: description: Controls access to resource. type: boolean example: false access_user_and_roles: description: Controls access to resource. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 allowed_pipelines: description: Relations to Pipelines. type: array items: description: >- Relation to AllowedPipeline, see: 'updateAllowedPipelineInput' object for properties. type: object properties: id: type: string format: uri allowed_lead_types: description: Relations to LeadTypes. type: array items: description: >- Relation to AllowedLeadType, see: 'updateAllowedLeadTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_quote_types: description: Relations to QuoteTypes. type: array items: description: >- Relation to AllowedQuoteType, see: 'updateAllowedQuoteTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_account_types: description: Relations to AccountTypes. type: array items: description: >- Relation to AllowedAccountType, see: 'updateAllowedAccountTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_contact_types: description: Relations to ContactTypes. type: array items: description: >- Relation to AllowedContactType, see: 'updateAllowedContactTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_company_emails: description: Relations to CompanyEmails. type: array items: description: >- Relation to AllowedCompanyEmail, see: 'updateAllowedCompanyEmailInput' object for properties. type: object properties: id: type: string format: uri allowed_company_phones: description: Relations to Phones. type: array items: description: >- Relation to AllowedCompanyPhone, see: 'updateAllowedCompanyPhoneInput' object for properties. type: object properties: id: type: string format: uri custom_entities: description: '' type: string format: binary example: blob x-stoplight: id: hy9zlrnvfztje batchMasterRightInput: properties: access_account_relation_types: description: Controls access to resource. type: boolean example: false access_accounts: description: Controls access to resource. type: boolean example: false access_appointment_scheduler: description: Controls access to resource. type: boolean example: false access_appointment_scheduler_management: description: Controls access to resource. type: boolean example: false access_approval_processes: description: Controls access to resource. type: boolean example: false access_approval_processes_management: description: Controls access to resource. type: boolean example: false access_approvals: description: Controls access to resource. type: boolean example: false access_archive: description: Controls access to resource. type: boolean example: false access_audit: description: Controls access to resource. type: boolean example: false access_audit_log: description: Controls access to resource. type: boolean example: false access_bulk_update: description: Controls access to resource. type: boolean example: false access_calling: description: Controls access to resource. type: boolean example: false access_calling_company_phone: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_calling_purchase_phone: description: Controls access to resource. type: boolean example: false access_company_emails: description: 'Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All' type: integer example: 0 enum: - 0 - 1 - 2 access_contacts: description: Controls access to resource. type: boolean example: false access_document_management: description: Controls access to resource. type: boolean example: false access_document_management_company: description: Controls access to resource. type: boolean example: false access_document_management_record: description: Controls access to resource. type: boolean example: false access_entity_account: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_account_delete: description: Controls access to resource. type: boolean example: false access_entity_account_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_account_private: description: Controls access to resource. type: boolean example: false access_entity_account_tag_create: description: Controls access to resource. type: boolean example: false access_entity_account_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_appointment: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_appointment_delete: description: Controls access to resource. type: boolean example: false access_entity_appointment_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_contact_delete: description: Controls access to resource. type: boolean example: false access_entity_contact_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_contact_private: description: Controls access to resource. type: boolean example: false access_entity_contact_tag_create: description: Controls access to resource. type: boolean example: false access_entity_contact_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_dashboard: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_dashboard_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_dashboard_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_email_content_share_mode: description: 'Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly' type: integer example: 0 enum: - 0 - 1 - 2 access_entity_email_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_sequence: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_email_template: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_email_template_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_email_template_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_forecast: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_forecast_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_forecast_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_form_view: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_form_view_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_form_view_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_lead: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_lead_delete: description: Controls access to resource. type: boolean example: false access_entity_lead_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_lead_private: description: Controls access to resource. type: boolean example: false access_entity_lead_tag_create: description: Controls access to resource. type: boolean example: false access_entity_lead_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_oppty: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_oppty_delete: description: Controls access to resource. type: boolean example: false access_entity_oppty_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_oppty_private: description: Controls access to resource. type: boolean example: false access_entity_oppty_tag_create: description: Controls access to resource. type: boolean example: false access_entity_pipeline: description: >- Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments type: integer example: 0 enum: - 0 - 1 - 2 - 3 access_entity_process: description: 'Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess' type: integer example: 1 enum: - 1 - 2 - 3 access_entity_profile: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_profile_default_screen_profiles: description: Field containing json. type: object access_entity_profile_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_profile_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_project: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_project_delete: description: Controls access to resource. type: boolean example: false access_entity_project_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_project_private: description: Controls access to resource. type: boolean example: false access_entity_project_tag_create: description: Controls access to resource. type: boolean example: false access_entity_quote: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_quote_delete: description: Controls access to resource. type: boolean example: false access_entity_quote_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_quote_types: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 access_entity_report: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_report_create_delete_folder: description: Controls access to resource. type: boolean example: false access_entity_report_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_report_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_custom: description: Controls access to resource. type: boolean example: false access_entity_report_sharing_public: description: Controls access to resource. type: boolean example: false access_entity_target: description: 'Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All' type: integer example: 0 enum: - 0 - 1 - 4 access_entity_target_delete_not_owned: description: Controls access to resource. type: boolean example: false access_entity_target_delete_owned: description: Controls access to resource. type: boolean example: false access_entity_task: description: >- Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 access_entity_task_delete: description: Controls access to resource. type: boolean example: false access_entity_task_direction: description: >- Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 access_entity_task_unassigned: description: Controls access to resource. type: boolean example: false access_export: description: Controls access to resource. type: boolean example: false access_feeds: description: Controls access to resource. type: boolean example: false access_foreign_currencies: description: Controls access to resource. type: boolean example: false access_form_and_fields: description: Controls access to resource. type: boolean example: false access_global_settings: description: Controls access to resource. type: boolean example: false access_home_screen: description: Controls access to resource. type: boolean example: false access_import: description: Controls access to resource. type: boolean example: false access_insights: description: Controls access to resource. type: boolean example: false access_leads: description: Controls access to resource. type: boolean example: false access_online_forms: description: Controls access to resource. type: boolean example: false access_online_forms_management: description: Controls access to resource. type: boolean example: false access_opportunity: description: Controls access to resource. type: boolean example: false access_pipeline_configuration: description: Controls access to resource. type: boolean example: false access_print: description: Controls access to resource. type: boolean example: false access_products_services: description: Controls access to resource. type: boolean example: false access_projects: description: Controls access to resource. type: boolean example: false access_quotes: description: Controls access to resource. type: boolean example: false access_sales_roles: description: Controls access to resource. type: boolean example: false access_security: description: Controls access to resource. type: boolean example: false access_units: description: Controls access to resource. type: boolean example: false access_user_and_roles: description: Controls access to resource. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 allowed_pipelines: description: Relations to Pipelines. type: array items: description: >- Relation to AllowedPipeline, see: 'updateAllowedPipelineInput' object for properties. type: object properties: id: type: string format: uri allowed_lead_types: description: Relations to LeadTypes. type: array items: description: >- Relation to AllowedLeadType, see: 'updateAllowedLeadTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_quote_types: description: Relations to QuoteTypes. type: array items: description: >- Relation to AllowedQuoteType, see: 'updateAllowedQuoteTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_account_types: description: Relations to AccountTypes. type: array items: description: >- Relation to AllowedAccountType, see: 'updateAllowedAccountTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_contact_types: description: Relations to ContactTypes. type: array items: description: >- Relation to AllowedContactType, see: 'updateAllowedContactTypeInput' object for properties. type: object properties: id: type: string format: uri allowed_company_emails: description: Relations to CompanyEmails. type: array items: description: >- Relation to AllowedCompanyEmail, see: 'updateAllowedCompanyEmailInput' object for properties. type: object properties: id: type: string format: uri allowed_company_phones: description: Relations to Phones. type: array items: description: >- Relation to AllowedCompanyPhone, see: 'updateAllowedCompanyPhoneInput' object for properties. type: object properties: id: type: string format: uri custom_entities: description: '' type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: kbnpqsn1lbi7b Memo: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 subject: description: Name of the entity and its default text representation. type: string example: string table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingClientRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri comments: description: Relations to MemoComments. type: array items: description: >- Relation to MemoComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MemoComment' object for properties. type: string format: uri required: - is_delete_protected - id - owner - owner_id - subject - table_name x-stoplight: id: 6464052ohk2vs createMemoInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 subject: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'createMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'createMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to MemoComments. type: array items: description: >- Relation to MemoComment, see: 'createMemoCommentInput' object for properties. type: object properties: id: type: string format: uri required: - owner_id - subject x-stoplight: id: fecgx0vyp0mdn updateMemoInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 subject: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to MemoComments. type: array items: description: >- Relation to MemoComment, see: 'updateMemoCommentInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: ko2zezgzatjo2 batchMemoInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 subject: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to MemoComments. type: array items: description: >- Relation to MemoComment, see: 'updateMemoCommentInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 18962zeeoxvw0 MemoComment: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri comment: description: Multi-line text input field. type: string example: string memo_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - memo - owner - comment - memo_id - owner_id x-stoplight: id: v7uq0kmn3jdd8 createMemoCommentInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true comment: description: Multi-line text input field. type: string example: string memo_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - comment - memo_id - owner_id x-stoplight: id: hiodl3g0t8ase updateMemoCommentInput: properties: comment: description: Multi-line text input field. type: string example: string memo_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 3sju0yl14pu5y batchMemoCommentInput: properties: comment: description: Multi-line text input field. type: string example: string memo_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: f5khmp0tbilbs MessageRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri email: description: >- 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. type: string format: uri memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - message_id x-stoplight: id: mf0p4d8n5tver createMessageRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - message_id x-stoplight: id: n9aqlcwbw6des updateMessageRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: rv6j2jn2ykl7j batchMessageRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6z9lmi4g8rj7l MessageSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri email: description: >- 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. type: string format: uri memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - client_id - message_id x-stoplight: id: 2v4s0ovo796vx createMessageSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - message_id x-stoplight: id: lhyp45v2nbyrv updateMessageSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: bpjx0sv8safqr batchMessageSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: jd977jko63jel MessageSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: >- 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. type: string format: uri memo: description: >- Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - unit - message_id - unit_id x-stoplight: id: 15zy2d9dh0nnb createMessageSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - message_id - unit_id x-stoplight: id: dgsx0h99seyh1 updateMessageSharingSalesUnitRelationInput: properties: message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: u1ldqpzkb15pc batchMessageSharingSalesUnitRelationInput: properties: message_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: yqwyavm3d1wde Note: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri custom_entity: description: >- Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - note - owner_id x-stoplight: id: ifo8bkc9t1pps createNoteInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - note - owner_id x-stoplight: id: 5u0cmcnpfw7cy updateNoteInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: i2hhjck5yrkxa batchNoteInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 custom_entity_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 note: description: Multi-line text input field. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: px83a2kjxy46d OnlineForm: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email: description: >- 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. type: string format: uri online_form_type: description: >- 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. type: string format: uri email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_ids: description: Field containing json. type: object online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: 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. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: 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. type: string format: uri lead_relations: description: Relations to Leads. type: array items: 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. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: 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. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: 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. type: string format: uri project_relations: description: Relations to Projects. type: array items: 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. type: string format: uri lines: description: Relations to OnlineFormActivityLogLines. type: array items: 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. type: string format: uri responded_by: description: '' type: string example: string response_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - online_form_type - field_ids - online_form_type_id - responded_by x-stoplight: id: gtvueful2bgui createOnlineFormInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_ids: description: Field containing json. type: object online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri required: - field_ids - online_form_type_id x-stoplight: id: mr3ttry80kegn updateOnlineFormInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_ids: description: Field containing json. type: object online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 0j3z9y872ne3m batchOnlineFormInput: properties: email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_ids: description: Field containing json. type: object online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 account_relations: description: Relations to Accounts. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: w6nv4nl3yvthr OnlineFormActivityLogLine: properties: formatted_text: description: '' type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true online_form: 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. type: string format: uri executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - formatted_text - is_delete_protected - id - online_form - online_form_id - sort_order x-stoplight: id: ud9joksvldlfc createOnlineFormActivityLogLineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - online_form_id - sort_order x-stoplight: id: uh7ihe8e6dfbu updateOnlineFormActivityLogLineInput: properties: executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: f9kuqohui0odd batchOnlineFormActivityLogLineInput: properties: executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: c3fxcszp5m9ab OnlineFormDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri online_form: 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. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - online_form - data_id - data_set_id - online_form_id x-stoplight: id: ufw4mmacc3ey9 createOnlineFormDataExRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - data_id - data_set_id - online_form_id x-stoplight: id: buwgjq0lgm1r8 updateOnlineFormDataExRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: eo0pqanngsgss batchOnlineFormDataExRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: jkhr4l9bybjat OnlineFormRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri online_form: 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. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - is_primary - online_form_id x-stoplight: id: 9qyk433rettq3 createOnlineFormRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_primary - online_form_id x-stoplight: id: bvqeb806yxvi2 updateOnlineFormRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 4iqwfzjj0xjzw batchOnlineFormRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 6fz60k92cd2sq OnlineFormType: properties: description: description: Multi-line text input field. type: string example: string has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: description: Form definition in json format. type: object is_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 activity_logs: description: Relations to OnlineForms. type: array items: 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. type: string format: uri link_id: description: '' type: string example: string link: description: '' type: string example: string has_custom_recaptcha: description: '' type: boolean example: false required: - has_draft - is_delete_protected - form_edit_api - id - owner - entity_type - form_edit - is_enabled - is_readonly - name - owner_id - link_id - has_custom_recaptcha x-stoplight: id: b8kh4nqxjhq7q createOnlineFormTypeInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: description: Form definition in json format. type: object is_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 custom_recaptcha: description: '' type: string format: binary example: blob required: - entity_type - form_edit - is_enabled - is_readonly - name - owner_id - custom_recaptcha x-stoplight: id: pxtbvo1kerdrd updateOnlineFormTypeInput: properties: description: description: Multi-line text input field. type: string example: string entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: description: Form definition in json format. type: object is_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 custom_recaptcha: description: '' type: string format: binary example: blob x-stoplight: id: 1f9xca0vtxkzs batchOnlineFormTypeInput: properties: description: description: Multi-line text input field. type: string example: string entity_type: description: >- 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 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: description: Form definition in json format. type: object is_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 custom_recaptcha: description: '' type: string format: binary example: blob id: description: ID of object to update. type: string format: uuid x-stoplight: id: jdq28iaqqg3x5 OnlineFormTypeEmailRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri email: description: >- 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. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri online_form_type: description: >- 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. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - email - online_form_type - email_id - online_form_type_id x-stoplight: id: 5nxb96k2sg7sg createOnlineFormTypeEmailRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - email_id - online_form_type_id x-stoplight: id: ugp9jgtduszj6 updateOnlineFormTypeEmailRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: vm89647hf4ous batchOnlineFormTypeEmailRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 online_form_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: qh589khoyjelp Opportunity: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties. type: string format: uri description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' active_quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri lead_source: description: >- 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. type: string format: uri oppty_type: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri product_currency: description: >- 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. type: string format: uri product_price_list: description: >- 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. type: string format: uri reason_of_close: description: >- 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. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri active_quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 closing_date: description: Closing date of the Opportunity. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false is_value_auto_calculate: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 was_qualified: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 value: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign oppty_recurrence: description: >- Relation to OpptyRecurrence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRecurrence' object for properties. type: string format: uri revenue_schedule: description: >- Relation to OpptyRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedule' object for properties. type: string format: uri product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri primary_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri primary_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyAccountRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri status: description: 'Integer enum value: 1 - Open, 2 - Lost, 3 - Won' type: integer example: 1 enum: - 1 - 2 - 3 readOnly: true qualify_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' won_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' days_in_step: description: '' type: integer format: int32 example: 1 is_favorite: description: '' type: boolean example: false sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingClientRelation' object for properties. type: string format: uri formatted_name: description: '' type: string example: string modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - oppty_type - owner - product_currency - step - unit - name - owner_id - step_id - table_name - status - days_in_step - is_favorite - formatted_name x-stoplight: id: 6rly6frz2i1c2 createOpportunityInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'createTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' active_quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 closing_date: description: Closing date of the Opportunity. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false is_value_auto_calculate: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 was_qualified: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 value: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign oppty_recurrence: description: >- Relation to OpptyRecurrence, see: 'createOpptyRecurrenceInput' object for properties. type: object properties: id: type: string format: uri revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'createOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'createLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: 'Relation to Quote, see: ''createQuoteInput'' object for properties.' type: object properties: id: type: string format: uri won_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'createLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'createLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri required: - name - owner_id - step_id x-stoplight: id: x9e611baxjc23 updateOpportunityInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' active_quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 closing_date: description: Closing date of the Opportunity. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false is_value_auto_calculate: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 was_qualified: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 value: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign oppty_recurrence: description: >- Relation to OpptyRecurrence, see: 'updateOpptyRecurrenceInput' object for properties. type: object properties: id: type: string format: uri revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: 'Relation to Quote, see: ''updateQuoteInput'' object for properties.' type: object properties: id: type: string format: uri won_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: ynrhi30oz6ede batchOpportunityInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' active_quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 closing_date: description: Closing date of the Opportunity. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false is_value_auto_calculate: description: Boolean value. type: boolean example: false label_flag: description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) type: integer example: 1 enum: - 1 - 2 - 4 lead_source_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string ranking: description: Qualitative ranking of the opportunity. type: integer format: int32 example: 1 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 was_qualified: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 value: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign oppty_recurrence: description: >- Relation to OpptyRecurrence, see: 'updateOpptyRecurrenceInput' object for properties. type: object properties: id: type: string format: uri revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: 'Relation to Quote, see: ''updateQuoteInput'' object for properties.' type: object properties: id: type: string format: uri won_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' lost_date: description: '' type: string format: date-time example: '2019-01-01T00:00:00' sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: pcsrbf4fxhxjp OpportunityType: properties: id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true pipeline: description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. type: string format: uri form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_qualify: description: Form derived definition in json format. type: object form_won: description: Form derived definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false form_lost_api: description: Form definition in json format. type: object form_qualify_api: description: Form derived definition in json format. type: list form_won_api: description: Form derived definition in json format. type: list required: - id - pipeline - is_readonly - name - pipeline_id - has_draft - is_delete_protected - form_edit_api - form_lost_api - form_qualify_api - form_won_api x-stoplight: id: cwuoz7kowna6o createOpportunityTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_qualify: description: Form derived definition in json format. type: object form_won: description: Form derived definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name - pipeline_id x-stoplight: id: 8spnv2vemp2lo updateOpportunityTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_qualify: description: Form derived definition in json format. type: object form_won: description: Form derived definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 5pudpyu5gst9a batchOpportunityTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_qualify: description: Form derived definition in json format. type: object form_won: description: Form derived definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: k29g795mnuxid OpptyProductRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri readOnly: true oppty_product_relation_type: description: >- Relation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties. type: string format: uri paired_oppty_product_relation: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri product: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri readOnly: true quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri amount: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 comment: description: Multi-line text input field. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 paired_oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quantity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 section_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedule' object for properties. type: string format: uri discount_value: description: '' type: number format: double example: 4.32 discount_percentage: description: '' type: number format: double example: 4.32 modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - oppty_product_relation_type - product - product_id x-stoplight: id: 543xerpqpptsh createOpptyProductRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true paired_oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri amount: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 comment: description: Multi-line text input field. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 paired_oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quantity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 section_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'createOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri required: - product_id x-stoplight: id: 20ub7wk3r3cgz updateOpptyProductRelationInput: properties: paired_oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri amount: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 comment: description: Multi-line text input field. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 paired_oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 quantity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 section_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: utxbh78u1ltzt batchOpptyProductRelationInput: properties: paired_oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri amount: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 comment: description: Multi-line text input field. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 paired_oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 quantity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 section_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: b0gpm5yrddxtz OpptyProductRelationDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri oppty_product_relation: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - oppty_product_relation - data_id - data_set_id - oppty_product_relation_id x-stoplight: id: jd7s2gw8p3jia createOpptyProductRelationDataExRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - oppty_product_relation - data_id - data_set_id - oppty_product_relation_id x-stoplight: id: eqmpn2e4rskjg updateOpptyProductRelationDataExRelationInput: properties: oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 1r6nxk6z83bys batchOpptyProductRelationDataExRelationInput: properties: oppty_product_relation: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: za1p46x1pulnr OpptyProductRelationRevenueSchedule: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: >- Unique identifier of entity. Must match with OpptyProductRelation id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 periods: description: Relations to OpptyProductRelationRevenueSchedulePeriods. type: array items: description: >- Relation to OpptyProductRelationRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedulePeriod' object for properties. type: string format: uri required: - is_delete_protected - id x-stoplight: id: 2kjdu35tqd31v createOpptyProductRelationRevenueScheduleInput: properties: id: description: >- Unique identifier of entity. Must match with OpptyProductRelation id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - id x-stoplight: id: nitt33ijcbh47 updateOpptyProductRelationRevenueScheduleInput: properties: is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: bk6tm67qy0e22 batchOpptyProductRelationRevenueScheduleInput: properties: is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: t3g09bexokpk0 OpptyProductRelationRevenueSchedulePeriod: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_product_relation_revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedule' object for properties. type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_product_relation_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - oppty_product_relation_revenue_schedule - oppty_product_relation_revenue_schedule_id - transaction_id x-stoplight: id: azcakoyoa3ak7 createOpptyProductRelationRevenueSchedulePeriodInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_product_relation_revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'createOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_product_relation_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - oppty_product_relation_revenue_schedule - oppty_product_relation_revenue_schedule_id - transaction_id x-stoplight: id: 95isqe4remlb0 updateOpptyProductRelationRevenueSchedulePeriodInput: properties: oppty_product_relation_revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_product_relation_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 5hspco9v18rdr batchOpptyProductRelationRevenueSchedulePeriodInput: properties: oppty_product_relation_revenue_schedule: description: >- Relation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_product_relation_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: sg9gz4opfelo8 OpptyProductRelationType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_type: description: >- Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties. type: string format: uri product_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name - product_type - product_type_id x-stoplight: id: mi3b2rh9lhd2d createOpptyProductRelationTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: uyeprvn8bpvb8 updateOpptyProductRelationTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: l89kw6o941eiq batchOpptyProductRelationTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: crx91p5bztxml OpptyRecurrence: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri condition: description: >- Bit Flag field, with limited combination of integer values. Options: Won = 1 (0b01) Lost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won. type: integer example: 1 enum: - 1 - 2 day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' step_id: description: >- Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - oppty - oppty_id - start_date - step_id x-stoplight: id: w0h3se3yracgt createOpptyRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true condition: description: >- Bit Flag field, with limited combination of integer values. Options: Won = 1 (0b01) Lost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won. type: integer example: 1 enum: - 1 - 2 day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' step_id: description: >- Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - oppty_id - start_date - step_id x-stoplight: id: demcmsz0c9rxl updateOpptyRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false condition: description: >- Bit Flag field, with limited combination of integer values. Options: Won = 1 (0b01) Lost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won. type: integer example: 1 enum: - 1 - 2 day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' step_id: description: >- Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: y3fky63t67wlt batchOpptyRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false condition: description: >- Bit Flag field, with limited combination of integer values. Options: Won = 1 (0b01) Lost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won. type: integer example: 1 enum: - 1 - 2 day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' step_id: description: >- Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: d02o5y1ws8kri OpptyRevenueSchedule: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. Must match with Opportunity id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 periods: description: Relations to OpptyRevenueSchedulePeriods. type: array items: description: >- Relation to OpptyRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedulePeriod' object for properties. type: string format: uri required: - is_delete_protected - id x-stoplight: id: w1idtv2rzfp1r createOpptyRevenueScheduleInput: properties: id: description: Unique identifier of entity. Must match with Opportunity id. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - id x-stoplight: id: xv4jpyn82ev3q updateOpptyRevenueScheduleInput: properties: is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 5o4pty5ks9ri8 batchOpptyRevenueScheduleInput: properties: is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false cancelation_date: description: Date information. type: string format: date example: '2019-01-01' period_count: description: Whole natural number. type: integer format: int32 example: 1 period_type: description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' type: integer example: 1 enum: - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: enlk0i7tx72in OpptyRevenueSchedulePeriod: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_revenue_schedule: description: >- Relation to OpptyRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedule' object for properties. type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - oppty_revenue_schedule - oppty_revenue_schedule_id - transaction_id x-stoplight: id: reo09a1myoq40 createOpptyRevenueSchedulePeriodInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'createOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - oppty_revenue_schedule - oppty_revenue_schedule_id - transaction_id x-stoplight: id: e2qxblbrcaoeo updateOpptyRevenueSchedulePeriodInput: properties: oppty_revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 98yqpjg0x38ff batchOpptyRevenueSchedulePeriodInput: properties: oppty_revenue_schedule: description: >- Relation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties. type: object properties: id: type: string format: uri date: description: Date information. type: string format: date example: '2019-01-01' oppty_revenue_schedule_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 transaction_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value: description: Floating point number. type: number format: double example: 4.32 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: x3hgtvb7t282r ParentAccountRelationType: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true child_label: description: Simple text input field. type: string example: string parent_label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - child_label - parent_label x-stoplight: id: 8nptxhuz4o919 createParentAccountRelationTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true child_label: description: Simple text input field. type: string example: string parent_label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - child_label - parent_label x-stoplight: id: ymevc6wyb6aa5 updateParentAccountRelationTypeInput: properties: child_label: description: Simple text input field. type: string example: string parent_label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: c9hyx3x0srjpz batchParentAccountRelationTypeInput: properties: child_label: description: Simple text input field. type: string example: string parent_label: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 0nxnygz4gthfo Phone: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string twilio_caller_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string type: description: >- Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany type: integer example: 1 enum: - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 message_forwarding_email: description: '' type: string example: string call_forwarding_phone: description: '' type: string example: string required: - is_delete_protected - id - name - type x-stoplight: id: 67n97oo0ox8hs createPhoneInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string twilio_caller_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string type: description: >- Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany type: integer example: 1 enum: - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name - type x-stoplight: id: mkhs8hwe73ove updatePhoneInput: properties: name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string twilio_caller_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string type: description: >- Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany type: integer example: 1 enum: - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 8mgcz0unosulh batchPhoneInput: properties: name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 phone_number: description: Phone number. type: string example: string twilio_caller_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string type: description: >- Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany type: integer example: 1 enum: - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7crocdce5mf0m Pipeline: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: Steps associated with this Pipeline. type: array items: $ref: '#/components/schemas/batchStepInput' opportunity_types: description: '' type: array items: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri required: - is_delete_protected - id - color - name - steps - opportunity_types x-stoplight: id: georea7j7kh7u createPipelineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: Steps associated with this Pipeline. type: array items: $ref: '#/components/schemas/batchStepInput' required: - color - name - steps x-stoplight: id: n0p5kws7cqkto updatePipelineInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: Steps associated with this Pipeline. type: array items: $ref: '#/components/schemas/batchStepInput' x-stoplight: id: 5q8qigku0m1ef batchPipelineInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: Steps associated with this Pipeline. type: array items: $ref: '#/components/schemas/batchStepInput' id: description: ID of object to update. type: string format: uuid x-stoplight: id: 9fq0txz4sh2gk Process: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri deactivation_reason: description: >- Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature type: integer example: 0 enum: - 0 - 1 - 2 - 3 is_enabled: description: Boolean value. type: boolean example: false last_schema_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' last_status_change: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 activity_logs: description: Relations to ProcessActivityLogs. type: array items: description: >- Relation to ProcessActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLog' object for properties. type: string format: uri activity: description: '' type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - name - owner_id - type - activity x-stoplight: id: cgy1ol0fi368u createProcessInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - name - owner_id - type x-stoplight: id: 1z64l21iuojnd updateProcessInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: nlzqvk8w175kg batchProcessInput: properties: description: description: Multi-line text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object type: description: 'Integer enum value: 1 - Personal, 2 - Space' type: integer example: 1 enum: - 1 - 2 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 88lnm7czmue8i ProcessActivityLog: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true actor: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri process: description: >- Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties. type: string format: uri actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cpu_run_time: description: Decimal number. type: number format: double example: 4.32 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false parent_process_ids: description: Field containing json. type: object process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 run_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 lines: description: Relations to ProcessActivityLogLines. type: array items: description: >- Relation to ProcessActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLogLine' object for properties. type: string format: uri record_name: description: '' type: string example: string required: - is_delete_protected - id - application - process - application_id - process_id - start_time - status x-stoplight: id: 5hbk17tebomax createProcessActivityLogInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cpu_run_time: description: Decimal number. type: number format: double example: 4.32 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false parent_process_ids: description: Field containing json. type: object process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 run_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - application_id - process_id - start_time - status x-stoplight: id: bbwbszvsl6kg9 updateProcessActivityLogInput: properties: actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cpu_run_time: description: Decimal number. type: number format: double example: 4.32 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false parent_process_ids: description: Field containing json. type: object process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 run_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: p3leagu1phujs batchProcessActivityLogInput: properties: actor_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 application_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cpu_run_time: description: Decimal number. type: number format: double example: 4.32 end_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_test_run: description: Boolean value. type: boolean example: false parent_process_ids: description: Field containing json. type: object process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 run_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 start_time: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: yu50e9qjikmw1 ProcessActivityLogLine: properties: formatted_text: description: '' type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true process_activity_log: description: >- Relation to ProcessActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLog' object for properties. type: string format: uri executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false process_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - formatted_text - is_delete_protected - id - process_activity_log - process_activity_log_id - sort_order x-stoplight: id: 7dlgx1sl8e5g8 createProcessActivityLogLineInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false process_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 required: - process_activity_log_id - sort_order x-stoplight: id: 4t0soi66ruhvv updateProcessActivityLogLineInput: properties: executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false process_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 x-stoplight: id: ixidjh829yhh6 batchProcessActivityLogLineInput: properties: executed_at: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' is_visible: description: Boolean value. type: boolean example: false process_activity_log_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 status: description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error' type: integer example: 1 enum: - 1 - 2 - 3 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ftjqrfficvjvs ProcessTemplate: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true is_recommended: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Form definition in json format. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri action_types: description: '' type: array items: type: string example: ArchiveRecord enum: - ArchiveRecord - CreateRecord - ManualTrigger - RecordChangedTrigger - ScheduledTrigger - SendEmail - SendWebhook - UpdateRecord required: - is_delete_protected - id - name - settings x-stoplight: id: 3vq4mznlnk3kb createProcessTemplateInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true is_recommended: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Form definition in json format. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - name - settings x-stoplight: id: se086twpia4wh updateProcessTemplateInput: properties: description: description: Multi-line text input field. type: string example: string is_recommended: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Form definition in json format. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: ftx0m7x96lrkc batchProcessTemplateInput: properties: description: description: Multi-line text input field. type: string example: string is_recommended: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string settings: description: Form definition in json format. type: object documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: vkhd1podcj4i4 Product: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true picture: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri product_category: description: >- Relation to ProductCategory. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductCategory' object for properties. type: string format: uri product_type: description: >- Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties. type: string format: uri allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_category_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sku: description: Simple text input field. type: string example: string unit_symbol: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_pipeline_relations: description: Relations to Pipelines. type: array items: description: >- Relation to ProductPipelineRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPipelineRelation' object for properties. type: string format: uri product_pipelines: description: Configuration of Pipelines where the Product can be used. type: object properties: pipelines: type: array items: description: An id of pipeline entity. type: string format: uuid allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 required: - pipelines - allowed_pipelines formatted_name: description: '' type: string example: string oppty_product_relation_type_id: description: '' type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - is_delete_protected - id - product_type - name - formatted_name - oppty_product_relation_type_id x-stoplight: id: 604qn2e8y95z5 createProductInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true picture: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_category_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sku: description: Simple text input field. type: string example: string unit_symbol: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_pipeline_relations: description: Relations to Pipelines. type: array items: description: >- Relation to ProductPipelineRelation, see: 'createProductPipelineRelationInput' object for properties. type: object properties: id: type: string format: uri product_pipelines: description: Configuration of Pipelines where the Product can be used. type: object properties: pipelines: type: array items: description: An id of pipeline entity. type: string format: uuid allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 required: - pipelines - allowed_pipelines picture_source_url: description: >- Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!! type: string example: string required: - name x-stoplight: id: wjpdt1s15nzrd updateProductInput: properties: description: description: Multi-line text input field. type: string example: string picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_category_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sku: description: Simple text input field. type: string example: string unit_symbol: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_pipeline_relations: description: Relations to Pipelines. type: array items: description: >- Relation to ProductPipelineRelation, see: 'updateProductPipelineRelationInput' object for properties. type: object properties: id: type: string format: uri product_pipelines: description: Configuration of Pipelines where the Product can be used. type: object properties: pipelines: type: array items: description: An id of pipeline entity. type: string format: uuid allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 required: - pipelines - allowed_pipelines picture_source_url: description: >- Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!! type: string example: string x-stoplight: id: hkfkte7jcu0z9 batchProductInput: properties: description: description: Multi-line text input field. type: string example: string picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_category_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sku: description: Simple text input field. type: string example: string unit_symbol: description: Simple text input field. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_pipeline_relations: description: Relations to Pipelines. type: array items: description: >- Relation to ProductPipelineRelation, see: 'updateProductPipelineRelationInput' object for properties. type: object properties: id: type: string format: uri product_pipelines: description: Configuration of Pipelines where the Product can be used. type: object properties: pipelines: type: array items: description: An id of pipeline entity. type: string format: uuid allowed_pipelines: description: 'Integer enum value: 1 - All, 2 - Selected' type: integer example: 1 enum: - 1 - 2 required: - pipelines - allowed_pipelines picture_source_url: description: >- Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!! type: string example: string id: description: ID of object to update. type: string format: uuid x-stoplight: id: dwlhdi3t4s5ik ProductCategory: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true parent: description: >- Relation to ProductCategory. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductCategory' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_relations: description: Relations to Products. type: array items: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri required: - is_delete_protected - id - name x-stoplight: id: qngpvojh7m4pz createProductCategoryInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_relations: description: Relations to Products. type: array items: description: >- Relation to Product, see: 'createProductInput' object for properties. type: object properties: id: type: string format: uri required: - name x-stoplight: id: ethevwknzg1qe updateProductCategoryInput: properties: name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_relations: description: Relations to Products. type: array items: description: >- Relation to Product, see: 'updateProductInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: xpgr5me4itpe7 batchProductCategoryInput: properties: name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_relations: description: Relations to Products. type: array items: description: >- Relation to Product, see: 'updateProductInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: tj109qbycs1yn ProductDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri product: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - product - data_id - data_set_id - product_id x-stoplight: id: f3n83ogya08es ProductPipelineRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true pipeline: description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. type: string format: uri product: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - pipeline - product - pipeline_id - product_id x-stoplight: id: vyfnraeczoua7 createProductPipelineRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - pipeline_id - product_id x-stoplight: id: c0ynzp9478ncb updateProductPipelineRelationInput: properties: pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: xlaop8qthqkwf batchProductPipelineRelationInput: properties: pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: lw2z8gf0s3pbo ProductPriceList: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_price_list_prices: description: Relations to Products. type: array items: description: >- Relation to ProductPriceListPrice. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceListPrice' object for properties. type: string format: uri required: - is_delete_protected - id - end_date - name - start_date x-stoplight: id: egtrjrhyhz924 createProductPriceListInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_price_list_prices: description: Relations to Products. type: array items: description: >- Relation to ProductPriceListPrice, see: 'createProductPriceListPriceInput' object for properties. type: object properties: id: type: string format: uri required: - end_date - name - start_date x-stoplight: id: fuac7eekd1p98 updateProductPriceListInput: properties: end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_price_list_prices: description: Relations to Products. type: array items: description: >- Relation to ProductPriceListPrice, see: 'updateProductPriceListPriceInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: h6dkv89rmq1pt batchProductPriceListInput: properties: end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string start_date: description: Date information. type: string format: date example: '2019-01-01' revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 product_price_list_prices: description: Relations to Products. type: array items: description: >- Relation to ProductPriceListPrice, see: 'updateProductPriceListPriceInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: rwfm3dtumhsx6 ProductPriceListPrice: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true currency: description: >- 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. type: string format: uri product: description: >- Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties. type: string format: uri product_price_list: description: >- 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. type: string format: uri currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - currency - product - product_price_list - currency_id - product_id - product_price_list_id x-stoplight: id: v2tb2fl40917v createProductPriceListPriceInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - currency_id - product_id - product_price_list_id x-stoplight: id: ur7s5yku58njz updateProductPriceListPriceInput: properties: currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: fy8ruhioe5pgm batchProductPriceListPriceInput: properties: currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 price: description: '' type: number format: double example: 4.32 product_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: err2sd0yihhxd ProductType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty_product_relation_type: description: >- Relation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties. type: string format: uri form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - has_draft - is_delete_protected - form_edit_api - id - oppty_product_relation_type - is_readonly - name - oppty_product_relation_type_id x-stoplight: id: s3j92z87s48ya createProductTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: ulfx3s0g65cr1 updateProductTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 0mfbgxkszn9nz batchProductTypeInput: properties: form_edit: description: Form definition in json format. type: object is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ruvbkjfh0kf3z Profile: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri entity: description: >- Integer enum value: 1 - Pipelinescreen, 2 - Timelinescreen, 3 - Archivescreen, 4 - Leadscreen, 6 - Accountscreen, 7 - Contactscreen, 8 - Activityscreen, 9 - Feedscreen, 10 - Hrmscreen, 11 - Auditscreen, 12 - Navigator, 13 - Insightsscreen, 14 - Indicatorsscreen, 15 - Conversionsscreen, 16 - Lifecyclescreen, 17 - Feedscreen2, 18 - ProductScreen, 19 - Projectscreen, 20 - Forecastscreen, 21 - LeadArchivescreen, 22 - TargetScreen, 23 - Quotescreen, 24 - QuoteArchivescreen, 25 - Approvalscreen, 26 - CustomEntityscreen, 27 - AccountArchivescreen, 28 - ContactArchivescreen type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 entity_api_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Field containing json. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 pipelines: description: '' type: array items: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - is_delete_protected - id - owner - entity - name - owner_id - settings - pipelines x-stoplight: id: eqg5m21uegrq7 ProfileSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri profile: description: >- Relation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - profile - client_id - profile_id x-stoplight: id: 7wb0wdtt6qp43 ProfileSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true profile: description: >- Relation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri profile_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - profile - unit - profile_id - unit_id x-stoplight: id: 359sr2t0jnw72 Project: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties. type: string format: uri description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri project_type: description: >- Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_goal: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ProjectSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ProjectSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectSharingClientRelation' object for properties. type: string format: uri primary_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ProjectContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectContactRelation' object for properties. type: string format: uri objectives: description: '' type: array items: description: >- Relation to ProjectObjective. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectObjective' object for properties. type: string format: uri is_favorite: description: '' type: boolean example: false status: description: 'Integer enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed' type: integer example: 1 enum: - 1 - 2 - 4 completion_rate: description: '' type: number format: double example: 4.32 activities_total: description: '' type: number format: double example: 4.32 activities_completed: description: '' type: number format: double example: 4.32 formatted_name: description: '' type: string example: string modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - owner - project_type - unit - end_date - name - owner_id - revenue_goal - is_favorite - status - formatted_name x-stoplight: id: w1efr2y7r5pki createProjectInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'createTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_goal: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ProjectSharingSalesUnitRelation, see: 'createProjectSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ProjectSharingClientRelation, see: 'createProjectSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ProjectContactRelation, see: 'createProjectContactRelationInput' object for properties. type: object properties: id: type: string format: uri required: - end_date - name - owner_id - revenue_goal x-stoplight: id: noikcy7ixs20v updateProjectInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_goal: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ProjectSharingSalesUnitRelation, see: 'updateProjectSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ProjectSharingClientRelation, see: 'updateProjectSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ProjectContactRelation, see: 'updateProjectContactRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: y0h4rgtrys88u batchProjectInput: properties: tags: description: Relations to Tags. type: array items: description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. type: object properties: id: type: string format: uri description: description: Multi-line text input field. type: string example: string account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 end_date: description: Date information. type: string format: date example: '2019-01-01' name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 revenue_goal: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ProjectSharingSalesUnitRelation, see: 'updateProjectSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ProjectSharingClientRelation, see: 'updateProjectSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ProjectContactRelation, see: 'updateProjectContactRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: p5htwpgeglky5 ProjectContactRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact - project - contact_id - is_primary - project_id x-stoplight: id: c4uojdcok728y createProjectContactRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_id - is_primary - project_id x-stoplight: id: ynvhcpeagigf9 updateProjectContactRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 29xce96wvtlax batchProjectContactRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7bxf0pqwoksnt ProjectDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - project - data_id - data_set_id - project_id x-stoplight: id: 2jq18crktv8s9 ProjectKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ProjectCompleted' type: integer example: 1 enum: - 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - project - kpi - owner_id - project_id x-stoplight: id: c0xq13pgblt0x createProjectKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ProjectCompleted' type: integer example: 1 enum: - 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - kpi - owner_id - project_id x-stoplight: id: xnajbq0jh5xog updateProjectKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ProjectCompleted' type: integer example: 1 enum: - 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: fhw0qobenzw5u batchProjectKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: 'Integer enum value: 1 - ProjectCompleted' type: integer example: 1 enum: - 1 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: s0xc603ymbjxj ProjectObjective: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true sort_order: description: '' type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - project - name - project_id - sort_order x-stoplight: id: 5gz3k1at7lab9 createProjectObjectiveInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true name: description: Name of the entity and its default text representation. type: string example: string project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true sort_order: description: '' type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name - project_id - sort_order x-stoplight: id: g5dh3vz2ce8qr updateProjectObjectiveInput: properties: name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: '' type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: o406qwvl9ipjx batchProjectObjectiveInput: properties: name: description: Name of the entity and its default text representation. type: string example: string sort_order: description: '' type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: bnapk1bfttk3z ProjectSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - project - client_id - project_id x-stoplight: id: feff6hpsosfdd createProjectSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - project_id x-stoplight: id: ljpiwr1d4fpo6 updateProjectSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 9jf4ulsatxkkx batchProjectSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: jj7hny2u4jri0 ProjectSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - project - unit - project_id - unit_id x-stoplight: id: cogqtn50iz55o createProjectSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - project_id - unit_id x-stoplight: id: 459af9zkztdwg updateProjectSharingSalesUnitRelationInput: properties: project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: cqr674coam9wm batchProjectSharingSalesUnitRelationInput: properties: project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: grz3rxmjfjbuf ProjectType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: 'Integer enum value: 0 - GeneralIcon, 1 - Account' type: integer example: 0 enum: - 0 - 1 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name x-stoplight: id: za661an904vdn createProjectTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: 'Integer enum value: 0 - GeneralIcon, 1 - Account' type: integer example: 0 enum: - 0 - 1 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: c8pq0wkink221 updateProjectTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: 'Integer enum value: 0 - GeneralIcon, 1 - Account' type: integer example: 0 enum: - 0 - 1 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: tcgnpms7zvlrt batchProjectTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: 'Integer enum value: 0 - GeneralIcon, 1 - Account' type: integer example: 0 enum: - 0 - 1 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: en6mtvpowlifj Quote: properties: description: description: Multi-line text input field. type: string example: string version: description: Whole natural number. type: integer format: int32 example: 1 is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri product_currency: description: >- 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. type: string format: uri product_price_list: description: >- 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. type: string format: uri quote_type: description: >- Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. type: string format: uri reason_of_close: description: >- 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. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri expiration_date: description: Date information. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string quote_number: description: Auto-generated sequence. type: string example: string readOnly: true quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 total_amount: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties. type: string format: uri primary_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri primary_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to QuoteContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteContactRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to QuoteAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteAccountRelation' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to QuoteSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to QuoteSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteSharingClientRelation' object for properties. type: string format: uri status: description: 'Integer enum value: 1 - Open, 2 - Lost, 3 - Accepted' type: integer example: 1 enum: - 1 - 2 - 3 readOnly: true formatted_name: description: '' type: string example: string is_favorite: description: '' type: boolean example: false is_active_in_opportunity: description: If quote is set as active in opportunity. type: boolean example: false modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - owner - product_currency - quote_type - step - unit - name - owner_id - quote_number - step_id - total_amount - status - formatted_name - is_favorite x-stoplight: id: vdwz4pva8hr27 createQuoteInput: properties: description: description: Multi-line text input field. type: string example: string version: description: Whole natural number. type: integer format: int32 example: 1 modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true expiration_date: description: Date information. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 total_amount: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to QuoteContactRelation, see: 'createQuoteContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to QuoteAccountRelation, see: 'createQuoteAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to QuoteSharingSalesUnitRelation, see: 'createQuoteSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to QuoteSharingClientRelation, see: 'createQuoteSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri is_active_in_opportunity: description: If quote is set as active in opportunity. type: boolean example: false required: - name - owner_id - step_id - total_amount x-stoplight: id: j80cv2ofo7s9h updateQuoteInput: properties: description: description: Multi-line text input field. type: string example: string version: description: Whole natural number. type: integer format: int32 example: 1 expiration_date: description: Date information. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 total_amount: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to QuoteContactRelation, see: 'updateQuoteContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to QuoteAccountRelation, see: 'updateQuoteAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to QuoteSharingSalesUnitRelation, see: 'updateQuoteSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to QuoteSharingClientRelation, see: 'updateQuoteSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri is_active_in_opportunity: description: If quote is set as active in opportunity. type: boolean example: false x-stoplight: id: welvmc78tzb5y batchQuoteInput: properties: description: description: Multi-line text input field. type: string example: string version: description: Whole natural number. type: integer format: int32 example: 1 expiration_date: description: Date information. type: string format: date example: '2019-01-01' is_archived: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_price_list_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_sections: description: Product sections on Opportunity in json format type: object quick_account_email: description: Simple text input field. type: string example: string quick_account_name: description: Simple text input field. type: string example: string quick_account_phone: description: Simple text input field. type: string example: string quick_contact_name: description: Simple text input field. type: string example: string quick_email: description: Simple text input field. type: string example: string quick_phone: description: Simple text input field. type: string example: string quote_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 reason_of_close_description: description: Multi-line text input field. type: string example: string reason_of_close_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 total_amount: description: Monetary value in a foreign currency. type: object properties: base_value: description: Currency. type: number format: double example: 4.32 currency_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 value_foreign: description: Decimal number. type: number format: double example: 4.32 required: - base_value - currency_id - value_foreign product_relations: description: Relations to Products. type: array items: description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to QuoteContactRelation, see: 'updateQuoteContactRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to QuoteAccountRelation, see: 'updateQuoteAccountRelationInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to QuoteSharingSalesUnitRelation, see: 'updateQuoteSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to QuoteSharingClientRelation, see: 'updateQuoteSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri is_active_in_opportunity: description: If quote is set as active in opportunity. type: boolean example: false id: description: ID of object to update. type: string format: uuid x-stoplight: id: jqnnrusja0rmv QuoteAccountRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - account - quote - account_id - is_primary - quote_id x-stoplight: id: 12inrlm2zeqke createQuoteAccountRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - account_id - is_primary - quote_id x-stoplight: id: mkpedcch2e89s updateQuoteAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 2w5q72tq354qd batchQuoteAccountRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: fiijo6q3ayntp QuoteContactRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - contact - quote - contact_id - is_primary - quote_id x-stoplight: id: o6tb2jerpxms2 createQuoteContactRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - contact_id - is_primary - quote_id x-stoplight: id: jalvl4ikdtatt updateQuoteContactRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: nsttz0donzcd9 batchQuoteContactRelationInput: properties: contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_primary: description: Boolean value. type: boolean example: false quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: a2qv9blkx03a0 QuoteDataExRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data: description: >- 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. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - data - quote - data_id - data_set_id - quote_id x-stoplight: id: 9v4u1ekij47v8 createQuoteDataExRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - data_id - data_set_id - quote_id x-stoplight: id: ctejgnbvjp0ze updateQuoteDataExRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: t6cy256o6y5sr batchQuoteDataExRelationInput: properties: data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_set_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7s30aorqp4xlo QuoteKPI: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - quote - kpi - owner_id - quote_id x-stoplight: id: wd1hv7lrrvmkn createQuoteKPIInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - kpi - owner_id - quote_id x-stoplight: id: 6hab04pv7wi1w updateQuoteKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: ai4cbbbxlj9i7 batchQuoteKPIInput: properties: application_id: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 kpi: description: >- Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove type: integer example: 1 enum: - 1 - 2 - 3 - 4 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: qeega5sdfsgr9 QuoteProcess: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' quote_types: description: '' type: array items: description: >- Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. type: string format: uri required: - is_delete_protected - id - name - steps - quote_types x-stoplight: id: 39a0bwo6htfcv createQuoteProcessInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' required: - name - steps x-stoplight: id: ici662ka8lbjy updateQuoteProcessInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' x-stoplight: id: 7bfgny8zaanne batchQuoteProcessInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 steps: description: '' type: array items: $ref: '#/components/schemas/batchStepInput' id: description: ID of object to update. type: string format: uuid x-stoplight: id: vhdabbebjye36 QuoteSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - quote - client_id - quote_id x-stoplight: id: kk9a7c5256klt createQuoteSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - quote_id x-stoplight: id: 1am0zgiamie1a updateQuoteSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 15xwsu3kvr2pf batchQuoteSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: bqe3q8a7pmhov QuoteSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - quote - unit - quote_id - unit_id x-stoplight: id: d2ac1v1eecgpr createQuoteSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - quote_id - unit_id x-stoplight: id: fsumi50jq9xzb updateQuoteSharingSalesUnitRelationInput: properties: quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: h9yfy0hm5e5tc batchQuoteSharingSalesUnitRelationInput: properties: quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: xfpltxc64xqxg QuoteType: properties: has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true quote_process: description: >- Relation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties. type: string format: uri form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 form_lost_api: description: Form definition in json format. type: object required: - has_draft - is_delete_protected - form_edit_api - id - quote_process - form_lost_enabled - is_readonly - name - quote_process_id - form_lost_api x-stoplight: id: xst0uwtx8huvh createQuoteTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - form_lost_enabled - is_readonly - name - quote_process_id x-stoplight: id: zmp436p072ecd updateQuoteTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 7l3po5ojv4vnu batchQuoteTypeInput: properties: form_edit: description: Form definition in json format. type: object form_lost: description: Form definition in json format. type: object form_lost_enabled: description: Boolean value. type: boolean example: false is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 7qdvpxehk0g6e Report: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri reports_folder: description: >- Relation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties. type: string format: uri access_link: description: Simple text input field. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 reports_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) type: integer example: 1 enum: - 1 - 2 type: description: >- Integer enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport type: integer example: 0 enum: - 0 - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 schedule: description: >- Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties. type: string format: uri is_favorite: description: '' type: boolean example: false sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to ReportSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to ReportSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSharingClientRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - reports_folder - name - owner_id - reports_folder_id - settings - type - is_favorite x-stoplight: id: sxhqsb9w22rp3 ReportFolder: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true parent_report_folder: description: >- Relation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_report_folder_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - name x-stoplight: id: ohx37qtt4i727 ReportSchedule: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri report: description: >- Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties. type: string format: uri owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - report - owner_id - report_id - settings x-stoplight: id: aqc4m9c98ozop createReportScheduleInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri required: - owner_id - report_id - settings x-stoplight: id: 0a2z9kv68e630 updateReportScheduleInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 8eb6k743c6plt batchReportScheduleInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 settings: description: Form definition in json format. type: object revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 79hwof0pg7doh ReportSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri report: description: >- Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - report - client_id - report_id x-stoplight: id: ykxstzmgolvm5 ReportSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true report: description: >- Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri report_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - report - unit - report_id - unit_id x-stoplight: id: 21woa81fb39lh SalesRole: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color_code - name x-stoplight: id: o93133bt3903r createSalesRoleInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color_code - name x-stoplight: id: ru8wue0va0n42 updateSalesRoleInput: properties: color_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: evggjcj9nz62i batchSalesRoleInput: properties: color_code: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 53bkooho6bcn6 SalesUnit: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true parent: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri picture: description: >- Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - name x-stoplight: id: prqgx558keqkw createSalesUnitInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true picture: description: >- Relation to CloudObject, see: 'createCloudObjectInput' object for properties. type: object properties: id: type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - name x-stoplight: id: 87y0mus331evv updateSalesUnitInput: properties: picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 387btyeiomuo2 batchSalesUnitInput: properties: picture: description: >- Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. type: object properties: id: type: string format: uri name: description: Name of the entity and its default text representation. type: string example: string parent_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 picture_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 2h4bu3k420c55 SalesUnitClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_role: description: 'Integer enum value: 1 - Member, 2 - Manager' type: integer example: 1 enum: - 1 - 2 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - unit - client_id - unit_id x-stoplight: id: y1g5fr3wz6c61 Step: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead_process: description: >- Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties. type: string format: uri pipeline: description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. type: string format: uri readOnly: true quote_process: description: >- Relation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties. type: string format: uri has_readonly_form: description: Boolean value. type: boolean example: false has_version_increment: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string percent: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: '' type: integer format: int32 example: 1 readOnly: true timeframe: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectStepRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectStepRelation' object for properties. type: string format: uri step_checklists: description: Relations to StepChecklists. type: array items: description: >- Relation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties. type: string format: uri required: - is_delete_protected - id - name - sort_order x-stoplight: id: hahx2zec1dp7e createStepInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true has_readonly_form: description: Boolean value. type: boolean example: false has_version_increment: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string percent: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 pipeline_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 timeframe: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectStepRelation, see: 'createCloudObjectStepRelationInput' object for properties. type: object properties: id: type: string format: uri step_checklists: description: Relations to StepChecklists. type: array items: description: >- Relation to StepChecklist, see: 'createStepChecklistInput' object for properties. type: object properties: id: type: string format: uri required: - name x-stoplight: id: s0ei2nzfbbsmv updateStepInput: properties: description: description: Multi-line text input field. type: string example: string has_readonly_form: description: Boolean value. type: boolean example: false has_version_increment: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string percent: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 timeframe: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectStepRelation, see: 'updateCloudObjectStepRelationInput' object for properties. type: object properties: id: type: string format: uri step_checklists: description: Relations to StepChecklists. type: array items: description: >- Relation to StepChecklist, see: 'updateStepChecklistInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 5pt3jyberwx89 batchStepInput: properties: description: description: Multi-line text input field. type: string example: string has_readonly_form: description: Boolean value. type: boolean example: false has_version_increment: description: Boolean value. type: boolean example: false lead_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string percent: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 quote_process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 timeframe: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectStepRelation, see: 'updateCloudObjectStepRelationInput' object for properties. type: object properties: id: type: string format: uri step_checklists: description: Relations to StepChecklists. type: array items: description: >- Relation to StepChecklist, see: 'updateStepChecklistInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 2l5q7qvel6yb7 StepChecklist: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true appointment_type: description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. type: string format: uri task_type: description: >- Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. type: string format: uri cloud_object_template: description: >- Relation to CloudObjectTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectTemplate' object for properties. type: string format: uri email_sequence: description: >- Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. type: string format: uri field: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri process: description: >- Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties. type: string format: uri send_email_field: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri send_email_template: description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri activity_type_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_format: description: 'Integer enum value: 0 - Default, 1 - Pdf' type: integer example: 0 enum: - 0 - 1 cloud_object_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_type: description: >- Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 item_validation: description: >- Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked type: integer example: 1 enum: - 1 - 2 - 3 label: description: Multi-line text input field. type: string example: string label_use_lang: description: Boolean value. type: boolean example: false process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 sort_order: description: '' type: integer format: int32 example: 1 readOnly: true step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 visibility_condition: description: '' type: string format: binary example: blob visibility_type: description: 'Integer enum value: 0 - Always, 1 - Condition' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to StepChecklistSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklistSalesRoleRelation' object for properties. type: string format: uri required: - is_delete_protected - id - step - sort_order - step_id - visibility_condition x-stoplight: id: 60u87h3p29ym5 createStepChecklistInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true cloud_object_template: description: >- Relation to CloudObjectTemplate, see: 'createCloudObjectTemplateInput' object for properties. type: object properties: id: type: string format: uri activity_type_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_format: description: 'Integer enum value: 0 - Default, 1 - Pdf' type: integer example: 0 enum: - 0 - 1 cloud_object_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_type: description: >- Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 item_validation: description: >- Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked type: integer example: 1 enum: - 1 - 2 - 3 label: description: Multi-line text input field. type: string example: string label_use_lang: description: Boolean value. type: boolean example: false process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 visibility_condition: description: '' type: string format: binary example: blob visibility_type: description: 'Integer enum value: 0 - Always, 1 - Condition' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to StepChecklistSalesRoleRelation, see: 'createStepChecklistSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri required: - step_id - visibility_condition x-stoplight: id: ranrjbah6v549 updateStepChecklistInput: properties: description: description: Multi-line text input field. type: string example: string cloud_object_template: description: >- Relation to CloudObjectTemplate, see: 'updateCloudObjectTemplateInput' object for properties. type: object properties: id: type: string format: uri activity_type_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_format: description: 'Integer enum value: 0 - Default, 1 - Pdf' type: integer example: 0 enum: - 0 - 1 cloud_object_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_type: description: >- Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 item_validation: description: >- Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked type: integer example: 1 enum: - 1 - 2 - 3 label: description: Multi-line text input field. type: string example: string label_use_lang: description: Boolean value. type: boolean example: false process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 visibility_condition: description: '' type: string format: binary example: blob visibility_type: description: 'Integer enum value: 0 - Always, 1 - Condition' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to StepChecklistSalesRoleRelation, see: 'updateStepChecklistSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: wghgfmfr9081l batchStepChecklistInput: properties: description: description: Multi-line text input field. type: string example: string cloud_object_template: description: >- Relation to CloudObjectTemplate, see: 'updateCloudObjectTemplateInput' object for properties. type: object properties: id: type: string format: uri activity_type_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 cloud_object_format: description: 'Integer enum value: 0 - Default, 1 - Pdf' type: integer example: 0 enum: - 0 - 1 cloud_object_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 email_sequence_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 item_type: description: >- Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 item_validation: description: >- Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked type: integer example: 1 enum: - 1 - 2 - 3 label: description: Multi-line text input field. type: string example: string label_use_lang: description: Boolean value. type: boolean example: false process_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 send_email_template_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 visibility_condition: description: '' type: string format: binary example: blob visibility_type: description: 'Integer enum value: 0 - Always, 1 - Condition' type: integer example: 0 enum: - 0 - 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sales_roles: description: Relations to SalesRoles. type: array items: description: >- Relation to StepChecklistSalesRoleRelation, see: 'updateStepChecklistSalesRoleRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: gtqe7yte8qt2s StepChecklistSalesRoleRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true sales_role: description: >- Relation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties. type: string format: uri step_checklist: description: >- Relation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties. type: string format: uri sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - sales_role - step_checklist - sales_role_id - step_checklist_id x-stoplight: id: domq86miqqx1k createStepChecklistSalesRoleRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - sales_role_id - step_checklist_id x-stoplight: id: fe3m915q2r32m updateStepChecklistSalesRoleRelationInput: properties: sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: t8gyqsbliul5f batchStepChecklistSalesRoleRelationInput: properties: sales_role_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_checklist_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ip0sm0i7bbjpf Tag: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true creator: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string supported_entities: description: |- Bit Flag field, with limited combination of integer values. Options: Contact = 1 (0b00001) Account = 2 (0b00010) Opportunity = 4 (0b00100) Lead = 8 (0b01000) Project = 16 (0b10000) type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - color - name x-stoplight: id: nl05cip2qqqsi createTagInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string supported_entities: description: |- Bit Flag field, with limited combination of integer values. Options: Contact = 1 (0b00001) Account = 2 (0b00010) Opportunity = 4 (0b00100) Lead = 8 (0b01000) Project = 16 (0b10000) type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - color - name x-stoplight: id: fpinoaeu62xwq updateTagInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: o2wgg2gvy3c2r batchTagInput: properties: color: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 creator_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 name: description: Name of the entity and its default text representation. type: string example: string use_lang: description: Boolean value. type: boolean example: false revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: chaycu55psc73 TagRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri tag: description: >- Relation to Tag. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Tag' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 tag_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - tag - tag_id x-stoplight: id: vq0uln8lqsxhv createTagRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 tag_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - tag_id x-stoplight: id: mot4374p1tfnt updateTagRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 tag_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 8egm8qiyiaitw batchTagRelationInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 tag_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 4aaft5x74ttvv Target: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri target_client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri calculation_type: description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' type: integer example: 1 enum: - 1 - 2 - 3 is_active: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 period_from: description: Date information. type: string format: date example: '2019-01-01' period_to: description: Date information. type: string format: date example: '2019-01-01' settings: description: '' type: string format: binary example: blob target_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 child_targets: description: Relations to Targets. type: array items: description: >- Relation to TargetRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TargetRelation' object for properties. type: string format: uri required: - is_delete_protected - id - owner - is_active - name - owner_id - settings x-stoplight: id: 236pntwi584ol createTargetInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true calculation_type: description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' type: integer example: 1 enum: - 1 - 2 - 3 is_active: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 period_from: description: Date information. type: string format: date example: '2019-01-01' period_to: description: Date information. type: string format: date example: '2019-01-01' target_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 child_targets: description: Relations to Targets. type: array items: description: >- Relation to TargetRelation, see: 'createTargetRelationInput' object for properties. type: object properties: id: type: string format: uri required: - is_active - name - owner_id x-stoplight: id: 3k31gn4sxxrrk updateTargetInput: properties: description: description: Multi-line text input field. type: string example: string calculation_type: description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' type: integer example: 1 enum: - 1 - 2 - 3 is_active: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 period_from: description: Date information. type: string format: date example: '2019-01-01' period_to: description: Date information. type: string format: date example: '2019-01-01' target_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 child_targets: description: Relations to Targets. type: array items: description: >- Relation to TargetRelation, see: 'updateTargetRelationInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: al9q74bcbqcs6 batchTargetInput: properties: description: description: Multi-line text input field. type: string example: string calculation_type: description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' type: integer example: 1 enum: - 1 - 2 - 3 is_active: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 period_from: description: Date information. type: string format: date example: '2019-01-01' period_to: description: Date information. type: string format: date example: '2019-01-01' target_client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting type: integer example: 1 enum: - 1 - 2 - 3 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 child_targets: description: Relations to Targets. type: array items: description: >- Relation to TargetRelation, see: 'updateTargetRelationInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: 547w952ham28b TargetRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true group_target: description: >- Relation to Target. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Target' object for properties. type: string format: uri user_target: description: >- Relation to Target. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Target' object for properties. type: string format: uri group_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 user_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - group_target - user_target - group_target_id - user_target_id x-stoplight: id: fy18epaq12at8 createTargetRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true group_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 user_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - group_target_id - user_target_id x-stoplight: id: m9rf7ps3ker6n updateTargetRelationInput: properties: group_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 user_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 8ts9qjqq068ec batchTargetRelationInput: properties: group_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 user_target_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: av8bxfj5mfvkr Task: properties: description: description: Multi-line text input field. type: string example: string is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true active_reminder: description: '' type: string format: date-time example: '2019-01-01T00:00:00' is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_type: description: >- Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. type: string format: uri call_outcome: description: >- 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. type: string format: uri owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 call_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 call_outcome_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 due_date: description: Task Due Date information. type: string format: date example: '2019-01-01' duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 priority: description: 'Integer enum value: 1 - Low, 2 - Medium, 3 - High' type: integer example: 1 enum: - 1 - 2 - 3 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' status: description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 subject: description: Name of the entity and its default text representation. type: string example: string table_name: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to TaskSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskSharingSalesUnitRelation' object for properties. type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to TaskSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskSharingClientRelation' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties. type: string format: uri reminder: description: >- Relation to TaskReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskReminder' object for properties. type: string format: uri task_recurrence: description: >- Relation to TaskRecurrence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskRecurrence' object for properties. type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties. type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityComment' object for properties. type: string format: uri formatted_name: description: '' type: string example: string modified_by_user: description: '' type: string format: date-time example: '2019-01-01T00:00:00' required: - is_delete_protected - id - activity_type - unit - subject - table_name - formatted_name x-stoplight: id: 05vi2ghd9asem createTaskInput: properties: description: description: Multi-line text input field. type: string example: string modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 call_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 call_outcome_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 due_date: description: Task Due Date information. type: string format: date example: '2019-01-01' duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 priority: description: 'Integer enum value: 1 - Low, 2 - Medium, 3 - High' type: integer example: 1 enum: - 1 - 2 - 3 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' status: description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to TaskSharingSalesUnitRelation, see: 'createTaskSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to TaskSharingClientRelation, see: 'createTaskSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties. type: object properties: id: type: string format: uri reminder: description: >- Relation to TaskReminder, see: 'createTaskReminderInput' object for properties. type: object properties: id: type: string format: uri task_recurrence: description: >- Relation to TaskRecurrence, see: 'createTaskRecurrenceInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'createActivityCommentInput' object for properties. type: object properties: id: type: string format: uri required: - subject x-stoplight: id: up5w7hf4djslc updateTaskInput: properties: description: description: Multi-line text input field. type: string example: string activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 call_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 call_outcome_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 due_date: description: Task Due Date information. type: string format: date example: '2019-01-01' duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 priority: description: 'Integer enum value: 1 - Low, 2 - Medium, 3 - High' type: integer example: 1 enum: - 1 - 2 - 3 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' status: description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to TaskSharingSalesUnitRelation, see: 'updateTaskSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to TaskSharingClientRelation, see: 'updateTaskSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string task_recurrence: description: >- Relation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: 18fkcxczzp7ra batchTaskInput: properties: description: description: Multi-line text input field. type: string example: string activity_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 call_duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 call_outcome_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 due_date: description: Task Due Date information. type: string format: date example: '2019-01-01' duration: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: number format: double example: 4.32 owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 priority: description: 'Integer enum value: 1 - Low, 2 - Medium, 3 - High' type: integer example: 1 enum: - 1 - 2 - 3 share_mode: description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit type: integer example: 0 enum: - 0 - 1 - 2 - 3 start_date: description: Date information. type: string format: date example: '2019-01-01' status: description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 subject: description: Name of the entity and its default text representation. type: string example: string unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 sharing_units: description: Relations to SalesUnits. type: array items: description: >- Relation to TaskSharingSalesUnitRelation, see: 'updateTaskSharingSalesUnitRelationInput' object for properties. type: object properties: id: type: string format: uri sharing_clients: description: Relations to Clients. type: array items: description: >- Relation to TaskSharingClientRelation, see: 'updateTaskSharingClientRelationInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri custom_entity_relations: description: Relations to CustomEntitys. type: array items: description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. type: object properties: id: type: string format: uri exchange_entity_id: description: '' type: string example: string gapi_entity_id: description: '' type: string example: string o365_entity_id: description: '' type: string example: string task_recurrence: description: >- Relation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties. type: object properties: id: type: string format: uri documents: description: Relations to CloudObjects. type: array items: description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. type: object properties: id: type: string format: uri comments: description: Relations to ActivityComments. type: array items: description: >- Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: nyapujmqjjm71 TaskRecurrence: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - task - start_date - task_id x-stoplight: id: hzs4gcz23u9bc createTaskRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - start_date - task_id x-stoplight: id: 4byf6yfayohlh updateTaskRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: wup93fd5y5rbm batchTaskRecurrenceInput: properties: apply_recurrence: description: >- Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply type: boolean example: false day: description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. type: integer example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 end_date: description: >- Date information. The last date when no more other items should be created. type: string format: date example: '2019-01-01' month: description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. type: integer format: int32 example: 1 occurrences_count: description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. type: integer format: int32 example: 1 start_date: description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. type: string format: date example: '2019-01-01' task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 type: description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 type: integer example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: aoi6r1qb9o773 TaskReminder: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 set_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - owner - task - owner_id - set_date - task_id x-stoplight: id: gwn53fgff0gei createTaskReminderInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 set_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - owner_id - set_date - task_id x-stoplight: id: bwjq07npvad1k updateTaskReminderInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 set_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 61uuo63i5baqr batchTaskReminderInput: properties: owner_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 set_date: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' status: description: 'Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed' type: integer example: 0 enum: - 0 - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: vtz46e4bah73o TaskSharingClientRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - client - task - client_id - task_id x-stoplight: id: yjk41xbhy6rl1 createTaskSharingClientRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - client_id - task_id x-stoplight: id: h0qbrxu3aec5v updateTaskSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: gyqmbjesd0y17 batchTaskSharingClientRelationInput: properties: client_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: umtlqiryodemg TaskSharingSalesUnitRelation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true task: description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. type: string format: uri unit: description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: string format: uri role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - task - unit - task_id - unit_id x-stoplight: id: 2nukdb2uzubqp createTaskSharingSalesUnitRelationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - task_id - unit_id x-stoplight: id: y7jmpbgzou8sl updateTaskSharingSalesUnitRelationInput: properties: role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: 0kcnyu2hxzg8s batchTaskSharingSalesUnitRelationInput: properties: role: description: 'Integer enum value: 1 - Watcher, 2 - Editor' type: integer example: 1 enum: - 1 - 2 task_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 unit_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: j4iidg7nltajs TaskType: properties: id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false is_delete_protected: 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. type: boolean example: false readOnly: true form_edit_api: description: Form definition in json format. type: object can_change_readonly: description: Returns if user can change readonly flag on this entity_type. type: boolean example: false required: - id - is_readonly - name - has_draft - is_delete_protected - form_edit_api x-stoplight: id: wge3b4v02anji createTaskTypeInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_readonly - name x-stoplight: id: yow4tebr6eb7n updateTaskTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: pnyetwt0nw4w1 batchTaskTypeInput: properties: form_edit: description: Form definition in json format. type: object icon: description: >- Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem type: integer example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 is_readonly: description: Boolean value. type: boolean example: false name: description: Name of the entity and its default text representation. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: q0xpgzroix6a9 TextMessage: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true text_message_conversation: description: >- Relation to TextMessageConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversation' object for properties. type: string format: uri content: description: String value. type: string example: string datetime_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 message_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string status: description: 'Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed' type: integer example: 1 enum: - 1 - 2 - 3 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - text_message_conversation - content - direction - text_message_conversation_id x-stoplight: id: uztuje940uj1p createTextMessageInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true content: description: String value. type: string example: string datetime_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 message_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string status: description: 'Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed' type: integer example: 1 enum: - 1 - 2 - 3 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - content - direction - text_message_conversation_id x-stoplight: id: ah9d04rhd4042 updateTextMessageInput: properties: content: description: String value. type: string example: string datetime_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 message_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string status: description: 'Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed' type: integer example: 1 enum: - 1 - 2 - 3 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: hzl6ub9zp9zog batchTextMessageInput: properties: content: description: String value. type: string example: string datetime_sent: description: Datetime information. type: string format: date-time example: '2019-01-01T00:00:00' direction: description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' type: integer example: 1 enum: - 1 - 2 message_sid: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string status: description: 'Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed' type: integer example: 1 enum: - 1 - 2 - 3 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: fq8qfu8mqh7ia TextMessageConversation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true phone: description: >- Relation to Phone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Phone' object for properties. type: string format: uri recipient_account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri recipient_contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_phone_number: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 messages: description: Relations to TextMessages. type: array items: description: >- Relation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties. type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties. type: string format: uri required: - is_delete_protected - id - phone - phone_id x-stoplight: id: 85xk2wiun9015 createTextMessageConversationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_phone_number: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 messages: description: Relations to TextMessages. type: array items: description: >- Relation to TextMessage, see: 'createTextMessageInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri required: - phone_id x-stoplight: id: a7bh3d0ihlaka updateTextMessageConversationInput: properties: phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_phone_number: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 messages: description: Relations to TextMessages. type: array items: description: >- Relation to TextMessage, see: 'updateTextMessageInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri x-stoplight: id: bcz5n30hm2jru batchTextMessageConversationInput: properties: phone_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 recipient_phone_number: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 messages: description: Relations to TextMessages. type: array items: description: >- Relation to TextMessage, see: 'updateTextMessageInput' object for properties. type: object properties: id: type: string format: uri account_relations: description: Relations to Accounts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri contact_relations: description: Relations to Contacts. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri project_relations: description: Relations to Projects. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri lead_relations: description: Relations to Leads. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri opportunity_relations: description: Relations to Opportunitys. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri quote_relations: description: Relations to Quotes. type: array items: description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. type: object properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid x-stoplight: id: h91a40oiud5yx TextMessageConversationRelations: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account: description: >- Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. type: string format: uri contact: description: >- Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. type: string format: uri lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri project: description: >- Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. type: string format: uri quote: description: >- Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. type: string format: uri text_message_conversation: description: >- Relation to TextMessageConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversation' object for properties. type: string format: uri account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - text_message_conversation - text_message_conversation_id x-stoplight: id: fywucs32vayp0 createTextMessageConversationRelationsInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - text_message_conversation_id x-stoplight: id: 7keoncz6sbab7 updateTextMessageConversationRelationsInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: loho18oksm7ql batchTextMessageConversationRelationsInput: properties: account_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 quote_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 text_message_conversation_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: 1181kbagh4npy Timeframe: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true lead: description: >- Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. type: string format: uri oppty: description: >- Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. type: string format: uri step: description: >- Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. type: string format: uri lead_oppty_id: description: |- Relation to single abstract entity instance. E.g. Relation to Lead/Oppty type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 step_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 timeframe: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id - step - lead_oppty_id - step_id - timeframe x-stoplight: id: 9fxgls7886zx1 Translation: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type: description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. type: string format: uri appointment_type: description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. type: string format: uri contact_type: description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. type: string format: uri data: description: >- 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. type: string format: uri field: description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. type: string format: uri lead_type: description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. type: string format: uri oppty_product_relation_type: description: >- Relation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties. type: string format: uri oppty_type: description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. type: string format: uri product_type: description: >- Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties. type: string format: uri project_type: description: >- Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties. type: string format: uri task_type: description: >- Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. type: string format: uri account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 de_de: description: Multi-line text input field. type: string example: string en_us: description: Multi-line text input field. type: string example: string es_es: description: Multi-line text input field. type: string example: string field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_type: description: 'Integer enum value: 0 - Edit, 1 - Lost' type: integer example: 0 enum: - 0 - 1 label_type: description: >- Integer enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription type: integer example: 0 enum: - 0 - 1 - 2 - 3 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pt_br: description: Multi-line text input field. type: string example: string task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - has_draft - id - label_type x-stoplight: id: e8whlz8ivstrz createTranslationInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 de_de: description: Multi-line text input field. type: string example: string en_us: description: Multi-line text input field. type: string example: string es_es: description: Multi-line text input field. type: string example: string field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_type: description: 'Integer enum value: 0 - Edit, 1 - Lost' type: integer example: 0 enum: - 0 - 1 label_type: description: >- Integer enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription type: integer example: 0 enum: - 0 - 1 - 2 - 3 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pt_br: description: Multi-line text input field. type: string example: string task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - label_type x-stoplight: id: wtzu3edv6tnpz updateTranslationInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 de_de: description: Multi-line text input field. type: string example: string en_us: description: Multi-line text input field. type: string example: string es_es: description: Multi-line text input field. type: string example: string field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_type: description: 'Integer enum value: 0 - Edit, 1 - Lost' type: integer example: 0 enum: - 0 - 1 label_type: description: >- Integer enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription type: integer example: 0 enum: - 0 - 1 - 2 - 3 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pt_br: description: Multi-line text input field. type: string example: string task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: s52gog9cz2j8b batchTranslationInput: properties: account_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 appointment_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 contact_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 data_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 de_de: description: Multi-line text input field. type: string example: string en_us: description: Multi-line text input field. type: string example: string es_es: description: Multi-line text input field. type: string example: string field_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 form_type: description: 'Integer enum value: 0 - Edit, 1 - Lost' type: integer example: 0 enum: - 0 - 1 label_type: description: >- Integer enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription type: integer example: 0 enum: - 0 - 1 - 2 - 3 lead_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_product_relation_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 oppty_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 product_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 project_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 pt_br: description: Multi-line text input field. type: string example: string task_type_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: ls0abzl2avnfe Type: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string example: string readOnly: true primitive_type: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: blob enum: - blob - bool - date - datetime - decimal - double - dynamic - enum - int - list - object - string - uuid readOnly: true validator: description: Field containing json. type: object readOnly: true flag: description: >- This field is bit flag which determinate purpose of the field and his abilities on form, following options are allowed CUSTOM_ALLOWED = 1 # field of this type can be created as new custom field CALC_ALLOWED = 2 # field can have calculation formula defined DEFAULT_ALLOWED = 4 # field can have default value defined MOBILE_ALLOWED = 8 # field can be displayed on form FIELD_MAP_REQUIRED = 16 # Obsolete FORM_FORBIDDEN = 32 # field of this type can't be located on form READONLY_ALLOWED = 64 # field can be defined as readonly on form ONLY_MAIN_FORM = 128 # field can be only at FORM_EDIT form not on e.g FORM_LOST ALLOWED_IN_CALC_FORMULA = 256 # field can be used within calculation expression MUST_BE_ON_FORM = 512 # field of this type can't be removed from form type: integer format: int32 example: 1 readOnly: true default_value: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string readOnly: true relation_type: description: >- Integer enum value: 0 - NO_RELATION, 1 - MANY_TO_ONE_SCALAR, 2 - MANY_TO_MANY_VECTOR type: integer example: 0 enum: - 0 - 1 - 2 readOnly: true container_size: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: integer format: int32 example: 1 readOnly: true is_groupable: description: Boolean value. type: boolean example: false readOnly: true is_filterable: description: Boolean value. type: boolean example: false readOnly: true is_sortable: description: Boolean value. type: boolean example: false readOnly: true is_selectable: description: Boolean value. type: boolean example: false readOnly: true required: - is_delete_protected - id - primitive_type - flag - relation_type - container_size - is_groupable - is_filterable - is_sortable - is_selectable x-stoplight: id: qyk0rtfasv14g UnsubscribedPhone: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true phone: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - id x-stoplight: id: csxs8klruw087 createUnsubscribedPhoneInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true phone: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: gky26e8x5ivno updateUnsubscribedPhoneInput: properties: phone: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: s96j5z0w3rv15 batchUnsubscribedPhoneInput: properties: phone: description: Phone number. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: n5bo1c38c6wcm Webhook: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true application: description: >- Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. type: string format: uri readOnly: true client: description: >- Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. type: string format: uri application_id: description: Id of definer application of the Webhook. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true client_id: description: Id of definer client of the Webhook. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 insecure_ssl: description: >- If True, remote side ssl certificate will not be validated when delivering notifications. type: boolean example: false options: description: >- Params in REST API format (snake case), to modify the content of the WebHook. You can set "entity" options of the main entity on which the event occurs. E.g. Account for events like Account.Create, Account.Update, Account.Delete. For events with a secondary related entity you can also options under key "related_entity". E.g. for Account.LinkedDocument event, the "expand" option of CloudObject(Document) can be set under "related_entity" key. Filter follows REST API conventions: http://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html In addition, to REST params, you can conditionally trigger webhook only when specified fields will change. You can use "on-field-change" param and provide a list of api names on which this change will listen. Suppressing Webhooks You can specify list of strings under "skip_keys" key in options. Whenever you make an API request with header "Webhook-Skip-Key" equal to any of the specified skip keys, the Webhook will not be triggered. This can prevent a Webhook loop. Example: { "entity": { "Contact": { "expand": [ "primary_account", "primary_contact", "task_relations.task" ], "load-only": [ "id", "primary_account", "primary_contact.first_name", "task_relations.task" ], "filter": { "email1": ["test@example.com", "test@example.net"], "email2": "test@example.com" }, "filter-op": {"email1": "eq"}, # optional, default operator is eq "on-field-change": ["email1"] }, "Account": { "filter": { "owner_id": ["9900cce6-bcd6-412a-bcd1-1904556c949a"] } } }, "related_entity": {"expand": ["contact"], "load-only": ["id", "contact"]}, "skip_keys": ["gmail_sync", "custom_integration"], "chunk_size": 100, // defines the size of the chunk, default is 100, max is 100. "chunk_delay": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0. "custom_entity_api_name": ["CE_Name1", "CE_Name2"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types. } type: object signature: description: >- Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 url: description: Webhook URL. type: string example: string events: description: '' type: array items: type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update required: - is_delete_protected - id - insecure_ssl - url - events x-stoplight: id: 3zv5gbm1k0h8e createWebhookInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true insecure_ssl: description: >- If True, remote side ssl certificate will not be validated when delivering notifications. type: boolean example: false options: description: >- Params in REST API format (snake case), to modify the content of the WebHook. You can set "entity" options of the main entity on which the event occurs. E.g. Account for events like Account.Create, Account.Update, Account.Delete. For events with a secondary related entity you can also options under key "related_entity". E.g. for Account.LinkedDocument event, the "expand" option of CloudObject(Document) can be set under "related_entity" key. Filter follows REST API conventions: http://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html In addition, to REST params, you can conditionally trigger webhook only when specified fields will change. You can use "on-field-change" param and provide a list of api names on which this change will listen. Suppressing Webhooks You can specify list of strings under "skip_keys" key in options. Whenever you make an API request with header "Webhook-Skip-Key" equal to any of the specified skip keys, the Webhook will not be triggered. This can prevent a Webhook loop. Example: { "entity": { "Contact": { "expand": [ "primary_account", "primary_contact", "task_relations.task" ], "load-only": [ "id", "primary_account", "primary_contact.first_name", "task_relations.task" ], "filter": { "email1": ["test@example.com", "test@example.net"], "email2": "test@example.com" }, "filter-op": {"email1": "eq"}, # optional, default operator is eq "on-field-change": ["email1"] }, "Account": { "filter": { "owner_id": ["9900cce6-bcd6-412a-bcd1-1904556c949a"] } } }, "related_entity": {"expand": ["contact"], "load-only": ["id", "contact"]}, "skip_keys": ["gmail_sync", "custom_integration"], "chunk_size": 100, // defines the size of the chunk, default is 100, max is 100. "chunk_delay": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0. "custom_entity_api_name": ["CE_Name1", "CE_Name2"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types. } type: object signature: description: >- Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 url: description: Webhook URL. type: string example: string events: description: '' type: array items: type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update required: - insecure_ssl - url - events x-stoplight: id: jftkucpsze30b updateWebhookInput: properties: insecure_ssl: description: >- If True, remote side ssl certificate will not be validated when delivering notifications. type: boolean example: false options: description: >- Params in REST API format (snake case), to modify the content of the WebHook. You can set "entity" options of the main entity on which the event occurs. E.g. Account for events like Account.Create, Account.Update, Account.Delete. For events with a secondary related entity you can also options under key "related_entity". E.g. for Account.LinkedDocument event, the "expand" option of CloudObject(Document) can be set under "related_entity" key. Filter follows REST API conventions: http://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html In addition, to REST params, you can conditionally trigger webhook only when specified fields will change. You can use "on-field-change" param and provide a list of api names on which this change will listen. Suppressing Webhooks You can specify list of strings under "skip_keys" key in options. Whenever you make an API request with header "Webhook-Skip-Key" equal to any of the specified skip keys, the Webhook will not be triggered. This can prevent a Webhook loop. Example: { "entity": { "Contact": { "expand": [ "primary_account", "primary_contact", "task_relations.task" ], "load-only": [ "id", "primary_account", "primary_contact.first_name", "task_relations.task" ], "filter": { "email1": ["test@example.com", "test@example.net"], "email2": "test@example.com" }, "filter-op": {"email1": "eq"}, # optional, default operator is eq "on-field-change": ["email1"] }, "Account": { "filter": { "owner_id": ["9900cce6-bcd6-412a-bcd1-1904556c949a"] } } }, "related_entity": {"expand": ["contact"], "load-only": ["id", "contact"]}, "skip_keys": ["gmail_sync", "custom_integration"], "chunk_size": 100, // defines the size of the chunk, default is 100, max is 100. "chunk_delay": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0. "custom_entity_api_name": ["CE_Name1", "CE_Name2"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types. } type: object signature: description: >- Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 url: description: Webhook URL. type: string example: string events: description: '' type: array items: type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update x-stoplight: id: 6xe9vgk547yc8 batchWebhookInput: properties: insecure_ssl: description: >- If True, remote side ssl certificate will not be validated when delivering notifications. type: boolean example: false options: description: >- Params in REST API format (snake case), to modify the content of the WebHook. You can set "entity" options of the main entity on which the event occurs. E.g. Account for events like Account.Create, Account.Update, Account.Delete. For events with a secondary related entity you can also options under key "related_entity". E.g. for Account.LinkedDocument event, the "expand" option of CloudObject(Document) can be set under "related_entity" key. Filter follows REST API conventions: http://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html In addition, to REST params, you can conditionally trigger webhook only when specified fields will change. You can use "on-field-change" param and provide a list of api names on which this change will listen. Suppressing Webhooks You can specify list of strings under "skip_keys" key in options. Whenever you make an API request with header "Webhook-Skip-Key" equal to any of the specified skip keys, the Webhook will not be triggered. This can prevent a Webhook loop. Example: { "entity": { "Contact": { "expand": [ "primary_account", "primary_contact", "task_relations.task" ], "load-only": [ "id", "primary_account", "primary_contact.first_name", "task_relations.task" ], "filter": { "email1": ["test@example.com", "test@example.net"], "email2": "test@example.com" }, "filter-op": {"email1": "eq"}, # optional, default operator is eq "on-field-change": ["email1"] }, "Account": { "filter": { "owner_id": ["9900cce6-bcd6-412a-bcd1-1904556c949a"] } } }, "related_entity": {"expand": ["contact"], "load-only": ["id", "contact"]}, "skip_keys": ["gmail_sync", "custom_integration"], "chunk_size": 100, // defines the size of the chunk, default is 100, max is 100. "chunk_delay": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0. "custom_entity_api_name": ["CE_Name1", "CE_Name2"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types. } type: object signature: description: >- Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 url: description: Webhook URL. type: string example: string events: description: '' type: array items: type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update id: description: ID of object to update. type: string format: uuid x-stoplight: id: risbmfra8gaqj WebhookEvent: properties: is_delete_protected: 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. type: boolean example: false readOnly: true id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true webhook: description: >- Relation to Webhook. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Webhook' object for properties. type: string format: uri event: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update webhook_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - is_delete_protected - id - webhook - event - webhook_id x-stoplight: id: kix4ebhobdyen createWebhookEventInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true event: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update webhook_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 required: - event - webhook_id x-stoplight: id: c9blbkc2p7jlz updateWebhookEventInput: properties: event: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update webhook_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 x-stoplight: id: evolc8euxhed6 batchWebhookEventInput: properties: event: description: >- Field whose values are strictly defined with an enumeration of values. type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.Update - ActivityRelation.* - ActivityRelation.Create - ActivityRelation.Delete - ActivityRelation.Update - Appointment.* - Appointment.Comment - Appointment.Create - Appointment.Delete - Appointment.DocumentLinked - Appointment.OwnerChanged - Appointment.Update - Contact.* - Contact.Create - Contact.Delete - Contact.DocumentLinked - Contact.OwnerChanged - Contact.Update - ContactAccountRelation.* - ContactAccountRelation.Create - ContactAccountRelation.Delete - ContactAccountRelation.Update - CustomEntity.* - CustomEntity.Create - CustomEntity.Delete - CustomEntity.DocumentLinked - CustomEntity.OwnerChanged - CustomEntity.Update - Email.* - Email.Create - Email.Delete - Email.DocumentLinked - Email.Update - Lead.* - Lead.BackToLead - Lead.Create - Lead.Delete - Lead.DocumentLinked - Lead.Lost - Lead.OwnerChanged - Lead.Update - LeadOpptyAccountRelation.* - LeadOpptyAccountRelation.Create - LeadOpptyAccountRelation.Delete - LeadOpptyAccountRelation.Update - LeadOpptyContactRelation.* - LeadOpptyContactRelation.Create - LeadOpptyContactRelation.Delete - LeadOpptyContactRelation.Update - Memo.* - Memo.Comment - Memo.Create - Memo.Delete - Memo.DocumentLinked - Memo.Update - Message.* - Message.Create - Message.Delete - Message.DocumentLinked - Message.Update - Opportunity.* - Opportunity.Create - Opportunity.Delete - Opportunity.DocumentLinked - Opportunity.Lost - Opportunity.Move - Opportunity.OwnerChanged - Opportunity.Qualify - Opportunity.Update - Opportunity.Won - OpptyProductRelation.* - OpptyProductRelation.Create - OpptyProductRelation.Delete - OpptyProductRelation.Update - Product.* - Product.Create - Product.Delete - Product.Update - Project.* - Project.Create - Project.Delete - Project.DocumentLinked - Project.OwnerChanged - Project.Update - Quote.* - Quote.Create - Quote.Delete - Quote.DocumentLinked - Quote.Lost - Quote.Move - Quote.OwnerChanged - Quote.Update - Quote.Won - QuoteAccountRelation.* - QuoteAccountRelation.Create - QuoteAccountRelation.Delete - QuoteAccountRelation.Update - QuoteContactRelation.* - QuoteContactRelation.Create - QuoteContactRelation.Delete - QuoteContactRelation.Update - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update webhook_id: description: Relation to single entity instance. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 id: description: ID of object to update. type: string format: uuid x-stoplight: id: rkm3stas5r3oz Webresource: properties: is_delete_protected: 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. type: boolean example: false readOnly: true has_draft: description: Set to True if draft for entity exists and can be published type: boolean example: false id: description: Unique identifier of entity. type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 readOnly: true is_deleted: description: Specifies if the entity is considered deleted. type: boolean example: false readOnly: true modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true display_param: description: |- Bit Flag field, with limited combination of integer values. Options: FullScreen = 1 (0b01) DoNotShowIfEmpty = 2 (0b10) type: integer example: 1 enum: - 1 - 2 entity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string request_method: description: 'Integer enum value: 1 - Get, 2 - Post' type: integer example: 1 enum: - 1 - 2 url: description: URL - HTTP address. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - is_delete_protected - has_draft - id - display_param - entity - name x-stoplight: id: ut30yvlh35a61 createWebresourceInput: properties: modified: description: Last modification time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true created: description: Creation time. type: string format: date-time example: '2019-01-01T00:00:00' readOnly: true display_param: description: |- Bit Flag field, with limited combination of integer values. Options: FullScreen = 1 (0b01) DoNotShowIfEmpty = 2 (0b10) type: integer example: 1 enum: - 1 - 2 entity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string request_method: description: 'Integer enum value: 1 - Get, 2 - Post' type: integer example: 1 enum: - 1 - 2 url: description: URL - HTTP address. type: string example: string is_published: description: '' type: boolean example: false readOnly: true revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 required: - display_param - entity - name x-stoplight: id: kemyfr871e1h3 updateWebresourceInput: properties: display_param: description: |- Bit Flag field, with limited combination of integer values. Options: FullScreen = 1 (0b01) DoNotShowIfEmpty = 2 (0b10) type: integer example: 1 enum: - 1 - 2 entity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string request_method: description: 'Integer enum value: 1 - Get, 2 - Post' type: integer example: 1 enum: - 1 - 2 url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 x-stoplight: id: nh67n2bxzn7am batchWebresourceInput: properties: display_param: description: |- Bit Flag field, with limited combination of integer values. Options: FullScreen = 1 (0b01) DoNotShowIfEmpty = 2 (0b10) type: integer example: 1 enum: - 1 - 2 entity: description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: string example: string name: description: Name of the entity and its default text representation. type: string example: string request_method: description: 'Integer enum value: 1 - Get, 2 - Post' type: integer example: 1 enum: - 1 - 2 url: description: URL - HTTP address. type: string example: string revision: description: Revision when entity was lastly changed. type: integer format: int32 example: 1 id: description: ID of object to update. type: string format: uuid x-stoplight: id: q7xmytdvnaxn8 AccountMergeAccountsRequest: type: object properties: master: $ref: '#/components/schemas/batchAccountInput' secondary_ids: type: array items: description: An id of secondary Account. type: string format: uuid AccountRemoveBatchRequest: type: array items: description: An id of entity Account to delete. type: string format: uuid AccountBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchAccountInput' AccountRemoveBatchKpIsRequest: type: array items: description: An id of entity AccountKPI to delete. type: string format: uuid AccountModifyBatchAccountKpIsRequest: type: array items: $ref: '#/components/schemas/batchAccountKPIInput' AccountRemoveBatchRelationsRequest: type: array items: description: An id of entity AccountRelation to delete. type: string format: uuid AccountModifyBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchAccountRelationInput' AccountRemoveBatchLabelsRequest: type: array items: description: An id of entity AccountRelationLabel to delete. type: string format: uuid AccountModifyRelationLabelsBatchRequest: type: array items: $ref: '#/components/schemas/batchAccountRelationLabelInput' AccountRemoveBatchByIdsRequest: type: array items: description: An id of entity AccountRelationType to delete. type: string format: uuid AccountModifyBatchAccountRelationTypesRequest: type: array items: $ref: '#/components/schemas/batchAccountRelationTypeInput' AccountRemoveBatchAccountRolesRequest: type: array items: description: An id of entity AccountRole to delete. type: string format: uuid AccountModifyBatchRolesRequest: type: array items: $ref: '#/components/schemas/batchAccountRoleInput' AccountRemoveBatchRequest1: type: array items: description: An id of entity AccountSharingClientRelation to delete. type: string format: uuid AccountModifyBatchAccountSharingClientRelationsRequest: type: array items: $ref: '#/components/schemas/batchAccountSharingClientRelationInput' AccountRemoveBatchSalesUnitRelationsRequest: type: array items: description: An id of entity AccountSharingSalesUnitRelation to delete. type: string format: uuid AccountUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchAccountSharingSalesUnitRelationInput' AccountRemoveBatchSocialRelationsRequest: type: array items: description: An id of entity AccountSocialRelation to delete. type: string format: uuid AccountModifyBatchSocialRelationsRequest: type: array items: $ref: '#/components/schemas/batchAccountSocialRelationInput' AccountRemoveBatchAccountTypesRequest: type: array items: description: An id of entity AccountType to delete. type: string format: uuid AccountModifyBatchAccountTypesRequest: type: array items: $ref: '#/components/schemas/batchAccountTypeInput' ActivityRemoveBatchRequest: type: array items: description: An id of entity ActivityComment to delete. type: string format: uuid ActivityModifyBatchCommentsRequest: type: array items: $ref: '#/components/schemas/batchActivityCommentInput' ActivityRemoveBatchRequest1: type: array items: description: An id of entity ActivityKPI to delete. type: string format: uuid ActivityCreateOrUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchActivityKPIInput' ActivityRemoveBatchActivityRelationsRequest: type: array items: description: An id of entity ActivityRelation to delete. type: string format: uuid ActivityModifyBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchActivityRelationInput' MasterRightRemoveAllowedAccountTypesRequest: type: array items: description: An id of entity AllowedAccountType to delete. type: string format: uuid MasterRightModifyAllowedAccountTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedAccountTypeInput' MasterRightRemoveBatchAllowedCompanyEmailsRequest: type: array items: description: An id of entity AllowedCompanyEmail to delete. type: string format: uuid MasterRightModifyAllowedCompanyEmailsBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedCompanyEmailInput' MasterRightRemoveBatchAllowedCompanyPhonesRequest: type: array items: description: An id of entity AllowedCompanyPhone to delete. type: string format: uuid MasterRightModifyAllowedCompanyPhonesBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedCompanyPhoneInput' MasterRightRemoveAllowedContactTypesRequest: type: array items: description: An id of entity AllowedContactType to delete. type: string format: uuid MasterRightModifyAllowedContactTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedContactTypeInput' MasterRightRemoveAllowedLeadTypesRequest: type: array items: description: An id of entity AllowedLeadType to delete. type: string format: uuid MasterRightModifyAllowedLeadTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedLeadTypeInput' MasterRightRemoveBatchAllowedPipelinesRequest: type: array items: description: An id of entity AllowedPipeline to delete. type: string format: uuid MasterRightBatchModifyAllowedPipelinesRequest: type: array items: $ref: '#/components/schemas/batchAllowedPipelineInput' MasterRightRemoveAllowedQuoteTypesRequest: type: array items: description: An id of entity AllowedQuoteType to delete. type: string format: uuid MasterRightModifyAllowedQuoteTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchAllowedQuoteTypeInput' ActivityRemoveAppointmentsRequest: type: array items: description: An id of entity Appointment to delete. type: string format: uuid ActivityModifyBatchAppointmentsRequest: type: array items: $ref: '#/components/schemas/batchAppointmentInput' ActivityRemoveBatchByIdsRequest: type: array items: description: An id of entity AppointmentClientInviteesRelation to delete. type: string format: uuid ActivityBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchAppointmentClientInviteesRelationInput' ActivityRemoveBatchRequest2: type: array items: description: An id of entity AppointmentContactInviteesRelation to delete. type: string format: uuid ActivityBatchCreateOrUpdateRequest1: type: array items: $ref: '#/components/schemas/batchAppointmentContactInviteesRelationInput' ActivityRemoveBatchAppointmentRemindersRequest: type: array items: description: An id of entity AppointmentReminder to delete. type: string format: uuid ActivityModifyBatchReminderRequest: type: array items: $ref: '#/components/schemas/batchAppointmentReminderInput' ActivityRemoveBatchByIdsRequest1: type: array items: description: An id of entity AppointmentSchedule to delete. type: string format: uuid ActivityModifyBatchAppointmentSchedulesRequest: type: array items: $ref: '#/components/schemas/batchAppointmentScheduleInput' ActivityRemoveBatchRequest3: type: array items: description: An id of entity AppointmentType to delete. type: string format: uuid ActivityModifyAppointmentTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchAppointmentTypeInput' ApprovalRemoveBatchRequest: type: array items: description: An id of entity Approval to delete. type: string format: uuid ApprovalModifyBatchApprovalsRequest: type: array items: $ref: '#/components/schemas/batchApprovalInput' ApprovalRemoveWithIdsRequest: type: array items: description: An id of entity ApprovalApprover to delete. type: string format: uuid ApprovalModifyBatchApprovalApproversRequest: type: array items: $ref: '#/components/schemas/batchApprovalApproverInput' ApprovalRemoveBatchRequest1: type: array items: description: An id of entity ApprovalProcess to delete. type: string format: uuid ApprovalModifyBatchApprovalProcessesRequest: type: array items: $ref: '#/components/schemas/batchApprovalProcessInput' ApprovalRemoveBatchByIdsRequest: type: array items: description: An id of entity ApprovalProcessActivityLogLine to delete. type: string format: uuid ApprovalUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchApprovalProcessActivityLogLineInput' CallRemoveBatchRequest: type: array items: description: An id of entity Call to delete. type: string format: uuid CallBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchCallInput' ClientRemoveBatchRequest: type: array items: description: An id of entity Client to delete. type: string format: uuid ClientBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchClientInput' ClientRemoveBatchRequest1: type: array items: description: An id of entity ClientExcludedOppty to delete. type: string format: uuid ClientModifyBatchClientExcludedOpptiesRequest: type: array items: $ref: '#/components/schemas/batchClientExcludedOpptyInput' ClientRemoveBatchFavoritesRequest: type: array items: description: An id of entity ClientFavorite to delete. type: string format: uuid ClientModifyFavoritesBatchRequest: type: array items: $ref: '#/components/schemas/batchClientFavoriteInput' ClientRemoveBatchRequest2: type: array items: description: An id of entity ClientStoryRead to delete. type: string format: uuid ClientCreateOrUpdateBatchClientStoryReadsRequest: type: array items: $ref: '#/components/schemas/batchClientStoryReadInput' DocumentRemoveByIdsRequest: type: array items: description: An id of entity CloudObject to delete. type: string format: uuid DocumentModifyCloudObjectsBatchRequest: type: array items: $ref: '#/components/schemas/batchCloudObjectInput' DocumentRemoveWithIdsRequest: type: array items: description: An id of entity CloudObjectFolder to delete. type: string format: uuid DocumentModifyCloudObjectFoldersBatchRequest: type: array items: $ref: '#/components/schemas/batchCloudObjectFolderInput' DocumentRemoveWithIdsRequest1: type: array items: description: An id of entity CloudObjectRelation to delete. type: string format: uuid DocumentModifyCloudObjectRelationsBatchRequest: type: array items: $ref: '#/components/schemas/batchCloudObjectRelationInput' DocumentRemoveCloudObjectStepRelationsRequest: type: array items: description: An id of entity CloudObjectStepRelation to delete. type: string format: uuid DocumentCreateOrUpdateBatchCloudObjectStepRelationsRequest: type: array items: $ref: '#/components/schemas/batchCloudObjectStepRelationInput' DocumentRemoveWithIdsRequest2: type: array items: description: An id of entity CloudObjectTemplate to delete. type: string format: uuid DocumentModifyCloudObjectTemplatesBatchRequest: type: array items: $ref: '#/components/schemas/batchCloudObjectTemplateInput' ContactMergeContactsRequest: type: object properties: master: $ref: '#/components/schemas/batchContactInput' secondary_ids: type: array items: description: An id of secondary Contact. type: string format: uuid ContactRemoveBatchRequest: type: array items: description: An id of entity Contact to delete. type: string format: uuid ContactBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchContactInput' ContactRemoveBatchRequest1: type: array items: description: An id of entity ContactAccountAccountRoleRelation to delete. type: string format: uuid ContactUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchContactAccountAccountRoleRelationInput' ContactRemoveBatchRelationsRequest: type: array items: description: An id of entity ContactAccountRelation to delete. type: string format: uuid ContactModifyBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchContactAccountRelationInput' ContactRemoveBatchByIdsRequest: type: array items: description: An id of entity ContactKPI to delete. type: string format: uuid ContactCreateOrUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchContactKPIInput' ContactRemoveBatchRequest2: type: array items: description: An id of entity ContactRelation to delete. type: string format: uuid ContactModifyBatchRelationsRequest1: type: array items: $ref: '#/components/schemas/batchContactRelationInput' ContactRemoveBatchByIdsRequest1: type: array items: description: An id of entity ContactRelationLabel to delete. type: string format: uuid ContactModifyBatchLabelsRequest: type: array items: $ref: '#/components/schemas/batchContactRelationLabelInput' ContactRemoveBatchByIdsRequest2: type: array items: description: An id of entity ContactRelationType to delete. type: string format: uuid ContactModifyBatchContactRelationTypesRequest: type: array items: $ref: '#/components/schemas/batchContactRelationTypeInput' ContactRemoveBatchRequest3: type: array items: description: An id of entity ContactSharingClientRelation to delete. type: string format: uuid ContactModifyBatchContactRelationsRequest: type: array items: $ref: '#/components/schemas/batchContactSharingClientRelationInput' ContactRemoveBatchByIdsRequest3: type: array items: description: An id of entity ContactSharingSalesUnitRelation to delete. type: string format: uuid ContactUpdateBatchRequest1: type: array items: $ref: '#/components/schemas/batchContactSharingSalesUnitRelationInput' ContactRemoveBatchSocialRelationsRequest: type: array items: description: An id of entity ContactSocialRelation to delete. type: string format: uuid ContactModifyBatchSocialRelationsRequest: type: array items: $ref: '#/components/schemas/batchContactSocialRelationInput' ContactRemoveByIdsRequest: type: array items: description: An id of entity ContactType to delete. type: string format: uuid ContactModifyBatchContactTypesRequest: type: array items: $ref: '#/components/schemas/batchContactTypeInput' CurrencyRemoveByIdRequest: type: array items: description: An id of entity Currency to delete. type: string format: uuid CurrencyBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchCurrencyInput' CurrencyRemoveByIdsRequest: type: array items: description: An id of entity CurrencyExchangeRate to delete. type: string format: uuid CurrencyExchangeRatesBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchCurrencyExchangeRateInput' CurrencyRemoveListRequest: type: array items: description: An id of entity CurrencyExchangeRatesList to delete. type: string format: uuid CurrencyExchangeRatesBatchModifyRequest1: type: array items: $ref: '#/components/schemas/batchCurrencyExchangeRatesListInput' CustomEntityRemoveBatchRequest: type: array items: description: An id of entity CustomEntity to delete. type: string format: uuid CustomEntityBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchCustomEntityInput' CustomEntityRemoveBatchRequest1: type: array items: description: An id of entity CustomEntityType to delete. type: string format: uuid CustomEntityBatchModifyRequest1: type: array items: $ref: '#/components/schemas/batchCustomEntityTypeInput' DataRemoveByIdBatchRequest: type: array items: description: An id of entity Data to delete. type: string format: uuid DataModifyBatchRequest: type: array items: $ref: '#/components/schemas/batchDataInput' DataRemoveByIdsRequest: type: array items: description: An id of entity DataRelation to delete. type: string format: uuid DataModifyBatchRequest1: type: array items: $ref: '#/components/schemas/batchDataRelationInput' EmailRemoveBatchRequest: type: array items: description: An id of entity Email to delete. type: string format: uuid EmailBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchEmailInput' EmailRemoveBatchContentRelationsRequest: type: array items: description: An id of entity EmailContentSharingClientRelation to delete. type: string format: uuid EmailBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchEmailContentSharingClientRelationInput' EmailRemoveByIdsRequest: type: array items: description: An id of entity EmailContentSharingSalesUnitRelation to delete. type: string format: uuid EmailModifyBatchEmailContentSharingSalesUnitRelationsRequest: type: array items: $ref: '#/components/schemas/batchEmailContentSharingSalesUnitRelationInput' EmailRemoveBatchEventsRequest: type: array items: description: An id of entity EmailEvent to delete. type: string format: uuid EmailModifyBatchEventsRequest: type: array items: $ref: '#/components/schemas/batchEmailEventInput' EmailSequenceRemoveBatchRequest: type: array items: description: An id of entity EmailSequence to delete. type: string format: uuid EmailSequenceBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchEmailSequenceInput' EmailSequenceRemoveBatchRequest1: type: array items: description: An id of entity EmailSequenceActivityLog to delete. type: string format: uuid EmailSequenceModifyBatchLogsRequest: type: array items: $ref: '#/components/schemas/batchEmailSequenceActivityLogInput' EmailSequenceRemoveByIdsRequest: type: array items: description: An id of entity EmailSequenceActivityLogLine to delete. type: string format: uuid EmailSequenceProcessBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchEmailSequenceActivityLogLineInput' EmailSequenceRemoveBatchRequest2: type: array items: description: An id of entity EmailSequenceEnrolled to delete. type: string format: uuid EmailSequenceBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchEmailSequenceEnrolledInput' EmailRemoveBatchEmailTemplatesRequest: type: array items: description: An id of entity EmailTemplate to delete. type: string format: uuid EmailModifyBatchTemplatesRequest: type: array items: $ref: '#/components/schemas/batchEmailTemplateInput' EmailRemoveBatchEmailTemplateFoldersRequest: type: array items: description: An id of entity EmailTemplateFolder to delete. type: string format: uuid EmailModifyBatchTemplateFoldersRequest: type: array items: $ref: '#/components/schemas/batchEmailTemplateFolderInput' EmailRemoveBatchByIdsRequest: type: array items: description: An id of entity EmailTemplateSharingClientRelation to delete. type: string format: uuid EmailTemplateBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchEmailTemplateSharingClientRelationInput' EmailRemoveBatchRequest1: type: array items: description: An id of entity EmailTemplateSharingSalesUnitRelation to delete. type: string format: uuid EmailModifyBatchEmailTemplateSharingSalesUnitRelationsRequest: type: array items: $ref: '#/components/schemas/batchEmailTemplateSharingSalesUnitRelationInput' OpportunityRemoveBatchRequest: type: array items: description: An id of entity EntityFitness to delete. type: string format: uuid OpportunityBatchModifyEntityFitnessesRequest: type: array items: $ref: '#/components/schemas/batchEntityFitnessInput' OpportunityBatchDeleteEntityFitnessIndicatorsRequest: type: array items: description: An id of entity EntityFitnessIndicator to delete. type: string format: uuid OpportunityModifyEntityFitnessIndicatorsBatchRequest: type: array items: $ref: '#/components/schemas/batchEntityFitnessIndicatorInput' AccountRemoveBatchEntityHealthsRequest: type: array items: description: An id of entity EntityHealth to delete. type: string format: uuid AccountModifyEntityHealthsBatchRequest: type: array items: $ref: '#/components/schemas/batchEntityHealthInput' LeadRemoveBatchEntityScoringsRequest: type: array items: description: An id of entity EntityScoring to delete. type: string format: uuid LeadCreateOrUpdateBatchEntityScoringsRequest: type: array items: $ref: '#/components/schemas/batchEntityScoringInput' FieldRemoveBatchRequest: type: array items: description: An id of entity FieldPermission to delete. type: string format: uuid FieldModifyBatchPermissionsRequest: type: array items: $ref: '#/components/schemas/batchFieldPermissionInput' ForecastRemoveByIdsRequest: type: array items: description: An id of entity Forecast to delete. type: string format: uuid ForecastModifyBatchForecastRequest: type: array items: $ref: '#/components/schemas/batchForecastInput' FormRemoveBatchRequest: type: array items: description: An id of entity FormView to delete. type: string format: uuid FormModifyBatchFormViewsRequest: type: array items: $ref: '#/components/schemas/batchFormViewInput' FormRemoveBatchRequest1: type: array items: description: An id of entity FormViewSharingClientRelation to delete. type: string format: uuid FormBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchFormViewSharingClientRelationInput' FormRemoveByIdsRequest: type: array items: description: An id of entity FormViewSharingSalesUnitRelation to delete. type: string format: uuid FormBatchCreateOrUpdateRequest1: type: array items: $ref: '#/components/schemas/batchFormViewSharingSalesUnitRelationInput' ContactRemoveBatchRequest4: type: array items: description: An id of entity GhostContact to delete. type: string format: uuid ContactModifyBatchGhostRequest: type: array items: $ref: '#/components/schemas/batchGhostContactInput' ContactRemoveBatchRequest5: type: array items: description: An id of entity GhostContactAccountAccountRoleRelation to delete. type: string format: uuid ContactCreateOrUpdateBatchRequest1: type: array items: $ref: '#/components/schemas/batchGhostContactAccountAccountRoleRelationInput' ContactRemoveBatchGhostContactRelationsRequest: type: array items: description: An id of entity GhostContactAccountRelation to delete. type: string format: uuid ContactCreateOrUpdateBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchGhostContactAccountRelationInput' ContactRemoveByIdsRequest1: type: array items: description: An id of entity GhostLeadOpptyContactRelation to delete. type: string format: uuid ContactModifyBatchGhostLeadOpptyContactRelationsRequest: type: array items: $ref: '#/components/schemas/batchGhostLeadOpptyContactRelationInput' ContactRemoveBatchGhostLeadOpptySalesRoleRelationsRequest: type: array items: description: An id of entity GhostLeadOpptyContactSalesRoleRelation to delete. type: string format: uuid ContactModifyBatchGhostLeadOpptySalesRoleRelationsRequest: type: array items: $ref: '#/components/schemas/batchGhostLeadOpptyContactSalesRoleRelationInput' ImportMappingMasksremoveBatchRequest: type: array items: description: An id of entity ImportMappingMask to delete. type: string format: uuid ImportMappingBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchImportMappingMaskInput' InterfaceRemoveWithIdsRequest: type: array items: description: An id of entity InterfacePreview to delete. type: string format: uuid InterfaceModifyBatchInterfacePreviewsRequest: type: array items: $ref: '#/components/schemas/batchInterfacePreviewInput' LeadOpportunityRemoveBatchRequest: type: array items: description: An id of entity Lead to delete. type: string format: uuid LeadOpportunityModifyBatchLeadsRequest: type: array items: $ref: '#/components/schemas/batchLeadInput' LeadOpportunityRemoveByIdsRequest: type: array items: description: An id of entity LeadOpptyAccountRelation to delete. type: string format: uuid LeadOpportunityModifyBatchLeadOpptyAccountRelationsRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptyAccountRelationInput' LeadOpportunityRemoveBatchRequest1: type: array items: description: An id of entity LeadOpptyContactGroupRelation to delete. type: string format: uuid LeadOpportunityBatchModifyLeadOpptyContactGroupRelationsRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactGroupRelationInput' LeadOpportunityRemoveByIdsRequest1: type: array items: description: An id of entity LeadOpptyContactRelation to delete. type: string format: uuid LeadOpportunityModifyBatchLeadOpptyContactRelationsRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactRelationInput' LeadOpportunityRemoveRelationsRequest: type: array items: description: An id of entity LeadOpptyContactSalesRoleRelation to delete. type: string format: uuid LeadOpportunityBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactSalesRoleRelationInput' LeadOpportunityRemoveBatchRequest2: type: array items: description: An id of entity LeadOpptyKPI to delete. type: string format: uuid LeadOpportunityBatchModifyRequest1: type: array items: $ref: '#/components/schemas/batchLeadOpptyKPIInput' LeadOpportunityRemoveBatchRequest3: type: array items: description: An id of entity LeadOpptySharingClientRelation to delete. type: string format: uuid LeadOpportunityBatchModifyRequest2: type: array items: $ref: '#/components/schemas/batchLeadOpptySharingClientRelationInput' LeadOpportunityRemoveBatchRequest4: type: array items: description: An id of entity LeadOpptySharingSalesUnitRelation to delete. type: string format: uuid LeadOpportunityBatchModifySalesUnitRelationsRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptySharingSalesUnitRelationInput' LeadOpportunityRemoveBatchByIdsRequest: type: array items: description: An id of entity LeadOpptyStepCheckListRelation to delete. type: string format: uuid LeadOpportunityBatchModifyRelationsRequest: type: array items: $ref: '#/components/schemas/batchLeadOpptyStepCheckListRelationInput' LeadOpportunityRemoveBatchRequest5: type: array items: description: An id of entity LeadProcess to delete. type: string format: uuid LeadOpportunityBatchModifyLeadProcessesRequest: type: array items: $ref: '#/components/schemas/batchLeadProcessInput' LeadOpportunityRemoveBatchRequest6: type: array items: description: An id of entity LeadType to delete. type: string format: uuid LeadOpportunityBatchModifyLeadTypesRequest: type: array items: $ref: '#/components/schemas/batchLeadTypeInput' MasterRightRemoveByIdRequest: type: array items: description: An id of entity MasterRight to delete. type: string format: uuid MasterRightModifyBatchMasterRightsRequest: type: array items: $ref: '#/components/schemas/batchMasterRightInput' MemoRemoveByIdRequest: type: array items: description: An id of entity Memo to delete. type: string format: uuid MemoBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchMemoInput' MemoRemoveByIdsRequest: type: array items: description: An id of entity MemoComment to delete. type: string format: uuid MemoModifyBatchMemoCommentsRequest: type: array items: $ref: '#/components/schemas/batchMemoCommentInput' MessageRemoveBatchRequest: type: array items: description: An id of entity MessageRelation to delete. type: string format: uuid MessageModifyBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchMessageRelationInput' MessageRemoveBatchRequest1: type: array items: description: An id of entity MessageSharingClientRelation to delete. type: string format: uuid MessageCreateOrUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchMessageSharingClientRelationInput' MessageRemoveBatchMessageSharingSalesUnitRelationsRequest: type: array items: description: An id of entity MessageSharingSalesUnitRelation to delete. type: string format: uuid MessageUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchMessageSharingSalesUnitRelationInput' NoteRemoveBatchRequest: type: array items: description: An id of entity Note to delete. type: string format: uuid NoteBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchNoteInput' OnlineRemoveBatchOnlineFormsRequest: type: array items: description: An id of entity OnlineForm to delete. type: string format: uuid OnlineModifyBatchOnlineFormsRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormInput' OnlineRemoveByIdsRequest: type: array items: description: An id of entity OnlineFormActivityLogLine to delete. type: string format: uuid OnlineActivityBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormActivityLogLineInput' OnlineRemoveBatchRequest: type: array items: description: An id of entity OnlineFormDataExRelation to delete. type: string format: uuid OnlineCreateOrUpdateBatchOnlineFormDataExRelationsRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormDataExRelationInput' OnlineRemoveBatchByIdsRequest: type: array items: description: An id of entity OnlineFormRelation to delete. type: string format: uuid OnlineModifyFormRelationsBatchRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormRelationInput' OnlineRemoveByIdsRequest1: type: array items: description: An id of entity OnlineFormType to delete. type: string format: uuid OnlineModifyFormBatchRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormTypeInput' OnlineRemoveBatchEmailRelationsRequest: type: array items: description: An id of entity OnlineFormTypeEmailRelation to delete. type: string format: uuid OnlineFormTypeEmailRelationsBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchOnlineFormTypeEmailRelationInput' LeadOpportunityRemoveBatchOpportunitiesRequest: type: array items: description: An id of entity Opportunity to delete. type: string format: uuid LeadOpportunityModifyBatchRequest: type: array items: $ref: '#/components/schemas/batchOpportunityInput' LeadOpportunityRemoveBatchOpportunityTypesRequest: type: array items: description: An id of entity OpportunityType to delete. type: string format: uuid LeadOpportunityBatchModifyOpportunityTypesRequest: type: array items: $ref: '#/components/schemas/batchOpportunityTypeInput' ProductLineItemsRemoveBatchOpptyProductRelationsRequest: type: array items: description: An id of entity OpptyProductRelation to delete. type: string format: uuid ProductLineItemsBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationInput' LeadOpportunityRemoveRelationsByIdsRequest: type: array items: description: An id of entity OpptyProductRelationDataExRelation to delete. type: string format: uuid LeadOpportunityBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationDataExRelationInput' LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulesRequest: type: array items: description: An id of entity OpptyProductRelationRevenueSchedule to delete. type: string format: uuid LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulesRequest: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationRevenueScheduleInput' LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulePeriodsRequest: type: array items: description: An id of entity OpptyProductRelationRevenueSchedulePeriod to delete. type: string format: uuid LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulePeriodsRequest: type: array items: $ref: >- #/components/schemas/batchOpptyProductRelationRevenueSchedulePeriodInput LeadOpportunityRemoveByIdsRequest2: type: array items: description: An id of entity OpptyProductRelationType to delete. type: string format: uuid LeadOpportunityModifyOpptyProductRelationTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationTypeInput' LeadOpportunityRemoveByIdsRequest3: type: array items: description: An id of entity OpptyRecurrence to delete. type: string format: uuid LeadOpportunityBatchModifyOpptyRecurrencesRequest: type: array items: $ref: '#/components/schemas/batchOpptyRecurrenceInput' LeadOpportunityRemoveBatchRequest7: type: array items: description: An id of entity OpptyRevenueSchedule to delete. type: string format: uuid LeadOpportunityModifyBatchOpptyRevenueSchedulesRequest: type: array items: $ref: '#/components/schemas/batchOpptyRevenueScheduleInput' LeadOpportunityRemoveBatchOpptyRevenueSchedulePeriodsRequest: type: array items: description: An id of entity OpptyRevenueSchedulePeriod to delete. type: string format: uuid LeadOpportunityBatchModifyOpptyRevenueSchedulePeriodsRequest: type: array items: $ref: '#/components/schemas/batchOpptyRevenueSchedulePeriodInput' AccountRemoveParentAccountRelationTypesRequest: type: array items: description: An id of entity ParentAccountRelationType to delete. type: string format: uuid AccountModifyParentAccountRelationTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchParentAccountRelationTypeInput' PhoneRemoveBatchRequest: type: array items: description: An id of entity Phone to delete. type: string format: uuid PhoneBatchModifyPhonesRequest: type: array items: $ref: '#/components/schemas/batchPhoneInput' PipelineRemoveBatchRequest: type: array items: description: An id of entity Pipeline to delete. type: string format: uuid PipelineBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchPipelineInput' ProcessRemoveBatchRequest: type: array items: description: An id of entity Process to delete. type: string format: uuid ProcessBatchModifyEntitiesRequest: type: array items: $ref: '#/components/schemas/batchProcessInput' ProcessRemoveByIdsRequest: type: array items: description: An id of entity ProcessActivityLog to delete. type: string format: uuid ProcessModifyBatchActivityLogsRequest: type: array items: $ref: '#/components/schemas/batchProcessActivityLogInput' ProcessRemoveByIdsRequest1: type: array items: description: An id of entity ProcessActivityLogLine to delete. type: string format: uuid ProcessCreateOrUpdateBatchLogLinesRequest: type: array items: $ref: '#/components/schemas/batchProcessActivityLogLineInput' ProcessRemoveByIdsRequest2: type: array items: description: An id of entity ProcessTemplate to delete. type: string format: uuid ProcessModifyBatchProcessTemplatesRequest: type: array items: $ref: '#/components/schemas/batchProcessTemplateInput' ProductRemoveBatchRequest: type: array items: description: An id of entity Product to delete. type: string format: uuid ProductBatchModifyProductsRequest: type: array items: $ref: '#/components/schemas/batchProductInput' ProductRemoveBatchRequest1: type: array items: description: An id of entity ProductCategory to delete. type: string format: uuid ProductModifyProductCategoriesBatchRequest: type: array items: $ref: '#/components/schemas/batchProductCategoryInput' ProductRemoveBatchRequest2: type: array items: description: An id of entity ProductPipelineRelation to delete. type: string format: uuid ProductModifyBatchProductPipelineRelationsRequest: type: array items: $ref: '#/components/schemas/batchProductPipelineRelationInput' ProductDeleteBatchRequest: type: array items: description: An id of entity ProductPriceList to delete. type: string format: uuid ProductModifyBatchProductPriceListsRequest: type: array items: $ref: '#/components/schemas/batchProductPriceListInput' ProductRemoveBatchPricesRequest: type: array items: description: An id of entity ProductPriceListPrice to delete. type: string format: uuid ProductPriceListPricesBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchProductPriceListPriceInput' ProductRemoveBatchRequest3: type: array items: description: An id of entity ProductType to delete. type: string format: uuid ProductModifyBatchProductTypesRequest: type: array items: $ref: '#/components/schemas/batchProductTypeInput' ProjectRemoveBatchRequest: type: array items: description: An id of entity Project to delete. type: string format: uuid ProjectBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchProjectInput' ProjectRemoveRelationsBatchRequest: type: array items: description: An id of entity ProjectContactRelation to delete. type: string format: uuid ProjectModifyRelationsBatchRequest: type: array items: $ref: '#/components/schemas/batchProjectContactRelationInput' ProjectRemoveBatchKpIsRequest: type: array items: description: An id of entity ProjectKPI to delete. type: string format: uuid ProjectModifyBatchProjectKpIsRequest: type: array items: $ref: '#/components/schemas/batchProjectKPIInput' ProjectRemoveBatchProjectObjectivesRequest: type: array items: description: An id of entity ProjectObjective to delete. type: string format: uuid ProjectModifyProjectObjectivesBatchRequest: type: array items: $ref: '#/components/schemas/batchProjectObjectiveInput' ProjectRemoveBatchRequest1: type: array items: description: An id of entity ProjectSharingClientRelation to delete. type: string format: uuid ProjectModifyBatchProjectSharingClientRelationsRequest: type: array items: $ref: '#/components/schemas/batchProjectSharingClientRelationInput' ProjectRemoveBatchByIdsRequest: type: array items: description: An id of entity ProjectSharingSalesUnitRelation to delete. type: string format: uuid ProjectUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchProjectSharingSalesUnitRelationInput' ProjectRemoveByIdsRequest: type: array items: description: An id of entity ProjectType to delete. type: string format: uuid ProjectModifyBatchProjectTypesRequest: type: array items: $ref: '#/components/schemas/batchProjectTypeInput' QuoteRemoveBatchRequest: type: array items: description: An id of entity Quote to delete. type: string format: uuid QuoteBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchQuoteInput' QuoteRemoveBatchByIdsRequest: type: array items: description: An id of entity QuoteAccountRelation to delete. type: string format: uuid QuoteModifyBatchQuoteAccountRelationsRequest: type: array items: $ref: '#/components/schemas/batchQuoteAccountRelationInput' QuoteRemoveBatchByIdsRequest1: type: array items: description: An id of entity QuoteContactRelation to delete. type: string format: uuid QuoteModifyBatchQuoteContactRelationsRequest: type: array items: $ref: '#/components/schemas/batchQuoteContactRelationInput' QuoteRemoveBatchRequest1: type: array items: description: An id of entity QuoteDataExRelation to delete. type: string format: uuid QuoteCreateOrUpdateBatchRequest: type: array items: $ref: '#/components/schemas/batchQuoteDataExRelationInput' QuoteRemoveBatchRequest2: type: array items: description: An id of entity QuoteKPI to delete. type: string format: uuid QuoteCreateOrUpdateBatchQuoteKpIsRequest: type: array items: $ref: '#/components/schemas/batchQuoteKPIInput' QuoteRemoveByIdsRequest: type: array items: description: An id of entity QuoteProcess to delete. type: string format: uuid QuoteProcessBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchQuoteProcessInput' QuoteRemoveBatchRequest3: type: array items: description: An id of entity QuoteSharingClientRelation to delete. type: string format: uuid QuoteCreateOrUpdateBatchRequest1: type: array items: $ref: '#/components/schemas/batchQuoteSharingClientRelationInput' QuoteRemoveBatchRequest4: type: array items: description: An id of entity QuoteSharingSalesUnitRelation to delete. type: string format: uuid QuoteBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchQuoteSharingSalesUnitRelationInput' QuoteRemoveByIdsRequest1: type: array items: description: An id of entity QuoteType to delete. type: string format: uuid QuoteModifyBatchQuoteTypesRequest: type: array items: $ref: '#/components/schemas/batchQuoteTypeInput' ReportRemoveBatchByIdsRequest: type: array items: description: An id of entity ReportSchedule to delete. type: string format: uuid ReportModifyBatchReportSchedulesRequest: type: array items: $ref: '#/components/schemas/batchReportScheduleInput' SalesRoleRemoveBatchRequest: type: array items: description: An id of entity SalesRole to delete. type: string format: uuid SalesRoleModifyBatchSalesRolesRequest: type: array items: $ref: '#/components/schemas/batchSalesRoleInput' SalesUnitRemoveBatchRequest: type: array items: description: An id of entity SalesUnit to delete. type: string format: uuid SalesUnitModifyBatchSalesUnitsRequest: type: array items: $ref: '#/components/schemas/batchSalesUnitInput' StepRemoveBatchRequest: type: array items: description: An id of entity Step to delete. type: string format: uuid StepBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchStepInput' StepRemoveBatchByIdsRequest: type: array items: description: An id of entity StepChecklist to delete. type: string format: uuid StepModifyBatchChecklistsRequest: type: array items: $ref: '#/components/schemas/batchStepChecklistInput' StepRemoveByIdsRequest: type: array items: description: An id of entity StepChecklistSalesRoleRelation to delete. type: string format: uuid StepModifyBatchStepChecklistSalesRoleRelationsRequest: type: array items: $ref: '#/components/schemas/batchStepChecklistSalesRoleRelationInput' TagRemoveBatchRequest: type: array items: description: An id of entity Tag to delete. type: string format: uuid TagBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchTagInput' TagRemoveBatchTagRelationsRequest: type: array items: description: An id of entity TagRelation to delete. type: string format: uuid TagModifyBatchTagRelationsRequest: type: array items: $ref: '#/components/schemas/batchTagRelationInput' TargetRemoveBatchRequest: type: array items: description: An id of entity Target to delete. type: string format: uuid TargetBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchTargetInput' TargetRemoveBatchRequest1: type: array items: description: An id of entity TargetRelation to delete. type: string format: uuid TargetModifyBatchRelationsRequest: type: array items: $ref: '#/components/schemas/batchTargetRelationInput' ActivityRemoveBatchTasksRequest: type: array items: description: An id of entity Task to delete. type: string format: uuid ActivityBatchModifyTasksRequest: type: array items: $ref: '#/components/schemas/batchTaskInput' ActivityRemoveTaskRecurrencesRequest: type: array items: description: An id of entity TaskRecurrence to delete. type: string format: uuid ActivityModifyBatchTaskRecurrencesRequest: type: array items: $ref: '#/components/schemas/batchTaskRecurrenceInput' ActivityRemoveTaskRemindersRequest: type: array items: description: An id of entity TaskReminder to delete. type: string format: uuid ActivityModifyTaskBatchRequest: type: array items: $ref: '#/components/schemas/batchTaskReminderInput' ActivityRemoveBatchRequest4: type: array items: description: An id of entity TaskSharingClientRelation to delete. type: string format: uuid ActivityCreateOrUpdateBatchRequest1: type: array items: $ref: '#/components/schemas/batchTaskSharingClientRelationInput' ActivityRemoveBatchTaskSharingSalesUnitRelationsRequest: type: array items: description: An id of entity TaskSharingSalesUnitRelation to delete. type: string format: uuid ActivityBatchCreateOrUpdateTaskSharingSalesUnitRelationsRequest: type: array items: $ref: '#/components/schemas/batchTaskSharingSalesUnitRelationInput' ActivityRemoveBatchTaskTypesRequest: type: array items: description: An id of entity TaskType to delete. type: string format: uuid ActivityModifyTaskTypesBatchRequest: type: array items: $ref: '#/components/schemas/batchTaskTypeInput' TextRemoveBatchRequest: type: array items: description: An id of entity TextMessage to delete. type: string format: uuid TextModifyBatchTextMessagesRequest: type: array items: $ref: '#/components/schemas/batchTextMessageInput' TextRemoveBatchRequest1: type: array items: description: An id of entity TextMessageConversation to delete. type: string format: uuid TextCreateOrUpdateBatchTextMessageConversationsRequest: type: array items: $ref: '#/components/schemas/batchTextMessageConversationInput' TextRemoveByIdsRequest: type: array items: description: An id of entity TextMessageConversationRelations to delete. type: string format: uuid TextBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchTextMessageConversationRelationsInput' TranslationRemoveByIdRequest: type: array items: description: An id of entity Translation to delete. type: string format: uuid TranslationBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchTranslationInput' UnsubscribedRemoveBatchPhonesRequest: type: array items: description: An id of entity UnsubscribedPhone to delete. type: string format: uuid UnsubscribedProcessBatchCreateOrUpdateRequest: type: array items: $ref: '#/components/schemas/batchUnsubscribedPhoneInput' WebhookRemoveBatchRequest: type: array items: description: An id of entity Webhook to delete. type: string format: uuid WebhookBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchWebhookInput' WebhookRemoveBatchRequest1: type: array items: description: An id of entity WebhookEvent to delete. type: string format: uuid WebhookBatchModifyEventsRequest: type: array items: $ref: '#/components/schemas/batchWebhookEventInput' WebresourceRemoveBatchRequest: type: array items: description: An id of entity Webresource to delete. type: string format: uuid WebresourceBatchModifyRequest: type: array items: $ref: '#/components/schemas/batchWebresourceInput' AccountRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Account type: string format: uuid AccountGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Account' AccountModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Account' AccountGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Account' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountAddNewAccountResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Account' AccountMergeAccountsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Account' AccountRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Account. type: string format: uuid - $ref: '#/components/schemas/Error' AccountBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountDataExRelation' AccountGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountKPI type: string format: uuid AccountGetKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountKPI' AccountModifyKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountKPI' AccountGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountKPI' AccountRemoveBatchKpIsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountKPI. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchAccountKpIsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountRelation type: string format: uuid AccountGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelation' AccountModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelation' AccountGetAllAccountRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelation' AccountRemoveBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountRelation. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountRelationLabel type: string format: uuid AccountGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationLabel' AccountModifyLabelResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationLabel' AccountGetAllLabelsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountRelationLabel' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateLabelResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationLabel' AccountRemoveBatchLabelsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountRelationLabel. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyRelationLabelsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountRelationType type: string format: uuid AccountGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationType' AccountModifyRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationType' AccountGetAllTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountRelationType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewAccountRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRelationType' AccountRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountRelationType. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchAccountRelationTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountRole type: string format: uuid AccountGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRole' AccountModifyRoleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRole' AccountGetAllRolesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountRole' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateRoleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountRole' AccountRemoveBatchAccountRolesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountRole. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchRolesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountSharingClientRelation type: string format: uuid AccountGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingClientRelation' AccountModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingClientRelation' AccountGetAllClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingClientRelation' AccountRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchAccountSharingClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountSharingSalesUnitRelation type: string format: uuid AccountGetById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' AccountUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' AccountListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' AccountRemoveBatchSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' AccountUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountSocialRelation type: string format: uuid AccountGetById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSocialRelation' AccountModifySocialRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSocialRelation' AccountGetAllSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountSocialRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewSocialRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountSocialRelation' AccountRemoveBatchSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountSocialRelation. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AccountType type: string format: uuid AccountGetTypeByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountType' AccountUpdateAccountTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountType' AccountGetAllAccountTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AccountType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AccountType' AccountRemoveBatchAccountTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AccountType. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyBatchAccountTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Activity' ActivityGetAllActivitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Activity' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ActivityComment type: string format: uuid ActivityGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityComment' ActivityModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityComment' ActivityGetAllActivityCommentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ActivityComment' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateNewActivityCommentResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityComment' ActivityRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ActivityComment. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchCommentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityDataExRelation' ActivityGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ActivityDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ActivityKPI type: string format: uuid ActivityGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityKPI' ActivityModifyKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityKPI' ActivityGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ActivityKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateNewKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityKPI' ActivityRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ActivityKPI. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityCreateOrUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ActivityRelation type: string format: uuid ActivityGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityRelation' ActivityModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityRelation' ActivityGetAllActivityRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ActivityRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateNewActivityRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ActivityRelation' ActivityRemoveBatchActivityRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ActivityRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedAccountType type: string format: uuid MasterRightGetAllowedAccountTypeByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedAccountType' MasterRightModifyAllowedAccountTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedAccountType' MasterRightGetAllowedAccountTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedAccountType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedAccountTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedAccountType' MasterRightRemoveAllowedAccountTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedAccountType. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedAccountTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedCompanyEmail type: string format: uuid MasterRightGetAllowedCompanyEmailResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyEmail' MasterRightUpdateAllowedCompanyEmailResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyEmail' MasterRightGetAllAllowedCompanyEmailsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedCompanyEmail' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedCompanyEmailResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyEmail' MasterRightRemoveBatchAllowedCompanyEmailsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedCompanyEmail. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedCompanyEmailsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedCompanyPhone type: string format: uuid MasterRightGetAllowedCompanyPhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyPhone' MasterRightUpdateAllowedCompanyPhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyPhone' MasterRightGetAllowedPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedCompanyPhone' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedCompanyPhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedCompanyPhone' MasterRightRemoveBatchAllowedCompanyPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedCompanyPhone. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedCompanyPhonesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveAllowedContactTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedContactType type: string format: uuid MasterRightGetAllowedContactTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedContactType' MasterRightUpdateAllowedContactTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedContactType' MasterRightGetAllowedContactTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedContactType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedContactTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedContactType' MasterRightRemoveAllowedContactTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedContactType. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedContactTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveAllowedLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedLeadType type: string format: uuid MasterRightGetAllowedLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedLeadType' MasterRightModifyAllowedLeadTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedLeadType' MasterRightGetAllowedLeadTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedLeadType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedLeadType' MasterRightRemoveAllowedLeadTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedLeadType. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedLeadTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveAllowedPipelineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedPipeline type: string format: uuid MasterRightGetAllowedPipelineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedPipeline' MasterRightModifyAllowedPipelineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedPipeline' MasterRightGetAllowedPipelinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedPipeline' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedPipelineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedPipeline' MasterRightRemoveBatchAllowedPipelinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedPipeline. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightBatchModifyAllowedPipelinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AllowedQuoteType type: string format: uuid MasterRightGetAllowedQuoteTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedQuoteType' MasterRightUpdateAllowedQuoteTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedQuoteType' MasterRightGetAllowedQuoteTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AllowedQuoteType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightCreateAllowedQuoteTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AllowedQuoteType' MasterRightRemoveAllowedQuoteTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AllowedQuoteType. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyAllowedQuoteTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ApiGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApiAccess' ApiAccessesListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ApiAccess' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Appointment type: string format: uuid ActivityGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Appointment' ActivityModifyAppointmentResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Appointment' ActivityGetAllAppointmentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Appointment' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateNewAppointmentResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Appointment' ActivityRemoveAppointmentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Appointment. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchAppointmentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AppointmentClientInviteesRelation type: string format: uuid ActivityGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentClientInviteesRelation' ActivityUpdateAppointmentClientInviteesRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentClientInviteesRelation' ActivityListAppointmentClientInviteesRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AppointmentClientInviteesRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentClientInviteesRelation' ActivityRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AppointmentClientInviteesRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AppointmentContactInviteesRelation type: string format: uuid ActivityGetById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentContactInviteesRelation' ActivityUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentContactInviteesRelation' ActivityListAppointmentContactInviteesRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AppointmentContactInviteesRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentContactInviteesRelation' ActivityRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AppointmentContactInviteesRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityBatchCreateOrUpdate200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AppointmentReminder type: string format: uuid ActivityGetById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentReminder' ActivityModifyAppointmentReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentReminder' ActivityGetAllAppointmentRemindersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AppointmentReminder' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateAppointmentReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentReminder' ActivityRemoveBatchAppointmentRemindersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AppointmentReminder. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AppointmentSchedule type: string format: uuid ActivityGetById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentSchedule' ActivityModifyAppointmentScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentSchedule' ActivityGetAllAppointmentSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AppointmentSchedule' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateAppointmentScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentSchedule' ActivityRemoveBatchByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AppointmentSchedule. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchAppointmentSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted AppointmentType type: string format: uuid ActivityGetById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentType' ActivityModifyAppointmentTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentType' ActivityGetAllAppointmentTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/AppointmentType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateAppointmentTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/AppointmentType' ActivityRemoveBatch200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted AppointmentType. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyAppointmentTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Approval type: string format: uuid ApprovalGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Approval' ApprovalModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Approval' ApprovalGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Approval' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ApprovalGenerateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Approval' ApprovalRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Approval. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalModifyBatchApprovalsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ApprovalApprover type: string format: uuid ApprovalGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalApprover' ApprovalModifyApproverResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalApprover' ApprovalGetAllApproversResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ApprovalApprover' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ApprovalCreateNewApproverResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalApprover' ApprovalRemoveWithIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ApprovalApprover. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalModifyBatchApprovalApproversResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ApprovalProcess type: string format: uuid ApprovalGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcess' ApprovalModifyProcessByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcess' ApprovalGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ApprovalProcess' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ApprovalCreateNewApprovalResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcess' ApprovalRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ApprovalProcess. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalModifyBatchApprovalProcessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ApprovalProcessActivityLogLine type: string format: uuid ApprovalGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcessActivityLogLine' ApprovalModifyLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcessActivityLogLine' ApprovalListApprovalProcessActivityLogLinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ApprovalProcessActivityLogLine' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ApprovalCreateLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ApprovalProcessActivityLogLine' ApprovalRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ApprovalProcessActivityLogLine. type: string format: uuid - $ref: '#/components/schemas/Error' ApprovalUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CallRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Call type: string format: uuid CallGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Call' CallModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Call' CallGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Call' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CallNewCallResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Call' CallRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Call. type: string format: uuid - $ref: '#/components/schemas/Error' CallBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ClientRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Client type: string format: uuid ClientGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Client' ClientModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Client' ClientGetAllDefinedClientsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Client' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ClientRegisterNewClientResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Client' ClientRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Client. type: string format: uuid - $ref: '#/components/schemas/Error' ClientBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ClientRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ClientExcludedOppty type: string format: uuid ClientGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientExcludedOppty' ClientModifyExcludedOpptiesByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientExcludedOppty' ClientListExcludedOpportunitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ClientExcludedOppty' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ClientCreateNewOpptyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientExcludedOppty' ClientRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ClientExcludedOppty. type: string format: uuid - $ref: '#/components/schemas/Error' ClientModifyBatchClientExcludedOpptiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ClientRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ClientFavorite type: string format: uuid ClientGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientFavorite' ClientUpdateClientFavoriteResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientFavorite' ClientGetAllFavoritesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ClientFavorite' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ClientCreateNewFavoriteResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientFavorite' ClientRemoveBatchFavoritesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ClientFavorite. type: string format: uuid - $ref: '#/components/schemas/Error' ClientModifyFavoritesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ClientGetSettingsByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientSetting' ClientGetSettingsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ClientSetting' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ClientRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ClientStoryRead type: string format: uuid ClientGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientStoryRead' ClientModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientStoryRead' ClientGetAllClientStoryReadsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ClientStoryRead' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ClientCreateClientStoryReadResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ClientStoryRead' ClientRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ClientStoryRead. type: string format: uuid - $ref: '#/components/schemas/Error' ClientCreateOrUpdateBatchClientStoryReadsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CloudObject type: string format: uuid DocumentGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObject' DocumentModifyCloudObjectResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObject' DocumentGetAllCloudObjectsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CloudObject' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DocumentCreateCloudObjectResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObject' DocumentRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CloudObject. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentModifyCloudObjectsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CloudObjectFolder type: string format: uuid DocumentGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectFolder' DocumentModifyCloudObjectFolderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectFolder' DocumentGetAllCloudObjectFoldersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CloudObjectFolder' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DocumentCreateFolderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectFolder' DocumentRemoveWithIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CloudObjectFolder. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentModifyCloudObjectFoldersBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CloudObjectRelation type: string format: uuid DocumentGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectRelation' DocumentModifyCloudObjectRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectRelation' DocumentGetAllCloudObjectRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CloudObjectRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DocumentCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectRelation' DocumentRemoveWithIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CloudObjectRelation. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentModifyCloudObjectRelationsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CloudObjectStepRelation type: string format: uuid DocumentGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectStepRelation' DocumentModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectStepRelation' DocumentGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CloudObjectStepRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DocumentCreateNewCloudObjectStepRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectStepRelation' DocumentRemoveCloudObjectStepRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CloudObjectStepRelation. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentCreateOrUpdateBatchCloudObjectStepRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CloudObjectTemplate type: string format: uuid DocumentGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectTemplate' DocumentModifyCloudObjectTemplateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectTemplate' DocumentGetAllCloudObjectTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CloudObjectTemplate' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DocumentCreateNewCloudObjectTemplateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CloudObjectTemplate' DocumentRemoveWithIds200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CloudObjectTemplate. type: string format: uuid - $ref: '#/components/schemas/Error' DocumentModifyCloudObjectTemplatesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CompanyEmailGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CompanyEmail' CompanyEmailGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CompanyEmail' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Contact type: string format: uuid ContactGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Contact' ContactModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Contact' ContactGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Contact' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Contact' ContactMergeContactsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Contact' ContactRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Contact. type: string format: uuid - $ref: '#/components/schemas/Error' ContactBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactAccountAccountRoleRelation type: string format: uuid ContactGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' ContactUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' ContactListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' ContactRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactAccountAccountRoleRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactAccountRelation type: string format: uuid ContactGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountRelation' ContactModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountRelation' ContactGetAllContactAccountRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactAccountRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactAccountRelation' ContactRemoveBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactAccountRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactDataExRelation' ContactGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactKPI type: string format: uuid ContactGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactKPI' ContactModifyKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactKPI' ContactGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactKPI' ContactRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactKPI. type: string format: uuid - $ref: '#/components/schemas/Error' ContactCreateOrUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactRelation type: string format: uuid ContactGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelation' ContactModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelation' ContactGetAllDefinedContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewContactRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelation' ContactRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchRelations200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactRelationLabel type: string format: uuid ContactGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationLabel' ContactModifyLabelResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationLabel' ContactGetAllLabelsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactRelationLabel' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateLabelResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationLabel' ContactRemoveBatchByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactRelationLabel. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchLabelsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactRelationType type: string format: uuid ContactGetById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationType' ContactModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationType' ContactGetAllContactRelationTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactRelationType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactRelationType' ContactRemoveBatchByIds200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactRelationType. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchContactRelationTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactSharingClientRelation type: string format: uuid ContactGetById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingClientRelation' ContactModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingClientRelation' ContactGetAllClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateRelation201Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingClientRelation' ContactRemoveBatch200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactSharingSalesUnitRelation type: string format: uuid ContactGetById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' ContactUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' ContactListRelations200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateRelation201Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' ContactRemoveBatchByIds200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactUpdateBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactSocialRelation type: string format: uuid ContactGetById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSocialRelation' ContactModifySocialRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSocialRelation' ContactGetAllSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactSocialRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewSocialRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactSocialRelation' ContactRemoveBatchSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactSocialRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchSocialRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ContactType type: string format: uuid ContactGetById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactType' ContactModifyById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactType' ContactGetAllTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ContactType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ContactType' ContactRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ContactType. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchContactTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Currency type: string format: uuid CurrencyGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Currency' CurrencyModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Currency' CurrencyGetAllCurrenciesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Currency' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CurrencyCreateNewCurrencyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Currency' CurrencyRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Currency. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CurrencyExchangeRate type: string format: uuid CurrencyGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRate' CurrencyModifyExchangeRateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRate' CurrencyGetAllRatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CurrencyExchangeRate' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CurrencyCreateExchangeRateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRate' CurrencyRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CurrencyExchangeRate. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyExchangeRatesBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CurrencyExchangeRatesList type: string format: uuid CurrencyGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRatesList' CurrencyUpdateExchangeRatesListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRatesList' CurrencyGetAllListsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CurrencyExchangeRatesList' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CurrencyCreateExchangeRatesListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CurrencyExchangeRatesList' CurrencyRemoveListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CurrencyExchangeRatesList. type: string format: uuid - $ref: '#/components/schemas/Error' CurrencyExchangeRatesBatchModify200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CustomEntityRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CustomEntity type: string format: uuid CustomEntityGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntity' CustomEntityModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntity' CustomEntityGetAllEntitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CustomEntity' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CustomEntityCreateNewCustomEntityResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntity' CustomEntityRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CustomEntity. type: string format: uuid - $ref: '#/components/schemas/Error' CustomEntityBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CustomEntityRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted CustomEntityType type: string format: uuid CustomEntityGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntityType' CustomEntityUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntityType' CustomEntityGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/CustomEntityType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true CustomEntityCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/CustomEntityType' CustomEntityRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted CustomEntityType. type: string format: uuid - $ref: '#/components/schemas/Error' CustomEntityBatchModify200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DataRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Data type: string format: uuid DataGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Data' DataModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Data' DataGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Data' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DataAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Data' DataRemoveByIdBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Data. type: string format: uuid - $ref: '#/components/schemas/Error' DataModifyBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' DataRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted DataRelation type: string format: uuid DataGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/DataRelation' DataModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/DataRelation' DataGetAllDataRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/DataRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true DataCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/DataRelation' DataRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted DataRelation. type: string format: uuid - $ref: '#/components/schemas/Error' DataModifyBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Email type: string format: uuid EmailGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Email' EmailModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Email' EmailGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Email' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Email' EmailRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Email. type: string format: uuid - $ref: '#/components/schemas/Error' EmailBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailContentSharingClientRelation type: string format: uuid EmailGetContentSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingClientRelation' EmailUpdateContentSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingClientRelation' EmailListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailContentSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateNewEmailContentSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingClientRelation' EmailRemoveBatchContentRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailContentSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' EmailBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailContentSharingSalesUnitRelation type: string format: uuid EmailGetContentSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' EmailModifyContentSharingSalesUnitRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' EmailGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' EmailRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailContentSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' EmailModifyBatchEmailContentSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailEvent type: string format: uuid EmailGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailEvent' EmailModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailEvent' EmailGetAllDefined200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailEvent' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateNewEmailEventResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailEvent' EmailRemoveBatchEventsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailEvent. type: string format: uuid - $ref: '#/components/schemas/Error' EmailModifyBatchEventsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailSequence type: string format: uuid EmailSequenceGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequence' EmailSequenceModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequence' EmailSequenceGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailSequence' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailSequenceCreateNewSequenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequence' EmailSequenceRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailSequence. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailSequenceActivityLog type: string format: uuid EmailSequenceGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLog' EmailSequenceModifyLogByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLog' EmailSequenceGetAllLogsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailSequenceActivityLog' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailSequenceCreateActivityLogResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLog' EmailSequenceRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailSequenceActivityLog. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceModifyBatchLogsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailSequenceActivityLogLine type: string format: uuid EmailSequenceGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLogLine' EmailSequenceModifyLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLogLine' EmailSequenceGetAll200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailSequenceActivityLogLine' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailSequenceAddNewLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceActivityLogLine' EmailSequenceRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailSequenceActivityLogLine. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceProcessBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailSequenceEnrolled type: string format: uuid EmailSequenceGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceEnrolled' EmailSequenceModifyEnrolledResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceEnrolled' EmailSequenceGetAll200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailSequenceEnrolled' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailSequenceEnrollNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailSequenceEnrolled' EmailSequenceRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailSequenceEnrolled. type: string format: uuid - $ref: '#/components/schemas/Error' EmailSequenceBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailTemplate type: string format: uuid EmailGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplate' EmailModifyTemplateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplate' EmailGetAllTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailTemplate' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateNewEmailTemplateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplate' EmailRemoveBatchEmailTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailTemplate. type: string format: uuid - $ref: '#/components/schemas/Error' EmailModifyBatchTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveTemplateFolderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailTemplateFolder type: string format: uuid EmailGetTemplateFolderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateFolder' EmailModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateFolder' EmailGetAllFoldersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailTemplateFolder' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateFolderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateFolder' EmailRemoveBatchEmailTemplateFoldersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailTemplateFolder. type: string format: uuid - $ref: '#/components/schemas/Error' EmailModifyBatchTemplateFoldersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailTemplateSharingClientRelation type: string format: uuid EmailGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' EmailUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' EmailListEmailTemplateSharingClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateNewEmailTemplateSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' EmailRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailTemplateSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' EmailTemplateBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' EmailRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EmailTemplateSharingSalesUnitRelation type: string format: uuid EmailGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' EmailModifySalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' EmailGetAllDefinedSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true EmailCreateRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' EmailRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EmailTemplateSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' EmailModifyBatchEmailTemplateSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' CustomEntityGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Entity' CustomEntityGetAllEntities200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Entity' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OpportunityRemoveFitnessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EntityFitness type: string format: uuid OpportunityGetFitnessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitness' OpportunityModifyFitnessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitness' OpportunityGetAllEntityFitnessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EntityFitness' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OpportunityCreateFitnessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitness' OpportunityRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EntityFitness. type: string format: uuid - $ref: '#/components/schemas/Error' OpportunityBatchModifyEntityFitnessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OpportunityRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EntityFitnessIndicator type: string format: uuid OpportunityGetFitnessIndicatorResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitnessIndicator' OpportunityUpdateFitnessIndicatorsByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitnessIndicator' OpportunityListEntityFitnessIndicatorsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EntityFitnessIndicator' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OpportunityCreateNewEntityFitnessIndicatorResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityFitnessIndicator' OpportunityBatchDeleteEntityFitnessIndicatorsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EntityFitnessIndicator. type: string format: uuid - $ref: '#/components/schemas/Error' OpportunityModifyEntityFitnessIndicatorsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EntityHealth type: string format: uuid AccountGetEntityHealthResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityHealth' AccountModifyHealthResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityHealth' AccountGetAllEntityHealthsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EntityHealth' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateEntityHealthResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityHealth' AccountRemoveBatchEntityHealthsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EntityHealth. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyEntityHealthsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted EntityScoring type: string format: uuid LeadGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityScoring' LeadModifyScoringResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityScoring' LeadGetAllEntityScoringsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/EntityScoring' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadCreateEntityScoringResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/EntityScoring' LeadRemoveBatchEntityScoringsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted EntityScoring. type: string format: uuid - $ref: '#/components/schemas/Error' LeadCreateOrUpdateBatchEntityScoringsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' FieldRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Field type: string format: uuid FieldGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Field' FieldModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Field' FieldGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Field' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true FieldAddNewFieldResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Field' FieldRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted FieldPermission type: string format: uuid FieldGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FieldPermission' FieldModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FieldPermission' FieldGetAllPermissionsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/FieldPermission' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true FieldCreateFieldPermissionResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FieldPermission' FieldRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted FieldPermission. type: string format: uuid - $ref: '#/components/schemas/Error' FieldModifyBatchPermissionsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' FieldGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FieldSequence' FieldGetAllFieldSequencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/FieldSequence' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ForecastRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Forecast type: string format: uuid ForecastGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Forecast' ForecastModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Forecast' ForecastGetAllForecastsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Forecast' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ForecastGenerateNewForecastResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Forecast' ForecastRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Forecast. type: string format: uuid - $ref: '#/components/schemas/Error' ForecastModifyBatchForecastResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' FormRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted FormView type: string format: uuid FormGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormView' FormModifyViewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormView' FormGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/FormView' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true FormCreateViewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormView' FormRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted FormView. type: string format: uuid - $ref: '#/components/schemas/Error' FormModifyBatchFormViewsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' FormRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted FormViewSharingClientRelation type: string format: uuid FormGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingClientRelation' FormUpdateFormViewSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingClientRelation' FormGetAllFormViewSharingClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/FormViewSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true FormCreateClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingClientRelation' FormRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted FormViewSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' FormBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' FormRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted FormViewSharingSalesUnitRelation type: string format: uuid FormGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingSalesUnitRelation' FormModifySalesUnitRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingSalesUnitRelation' FormGetAllSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/FormViewSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true FormCreateNewRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/FormViewSharingSalesUnitRelation' FormRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted FormViewSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' FormBatchCreateOrUpdate200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted GhostContact type: string format: uuid ContactGetById200Response11: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContact' ContactModifyById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContact' ContactGetAllDefined200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/GhostContact' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNew201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContact' ContactRemoveBatch200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted GhostContact. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchGhostResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response11: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted GhostContactAccountAccountRoleRelation type: string format: uuid ContactGetById200Response12: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' ContactModifyRelation200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' ContactListGhostAccountRoleRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateGhostAccountRoleRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' ContactRemoveBatch200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted GhostContactAccountAccountRoleRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactCreateOrUpdateBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response12: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted GhostContactAccountRelation type: string format: uuid ContactGetRelationByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountRelation' ContactUpdateRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountRelation' ContactGetAllRelations200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/GhostContactAccountRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateRelation201Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostContactAccountRelation' ContactRemoveBatchGhostContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted GhostContactAccountRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactCreateOrUpdateBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response13: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted GhostLeadOpptyContactRelation type: string format: uuid ContactGetById200Response13: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' ContactModifyRelationWithIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' ContactListGhostLeadOpptyContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateGhostLeadOpptyContactRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' ContactRemoveByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted GhostLeadOpptyContactRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchGhostLeadOpptyContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ContactRemoveById200Response14: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted GhostLeadOpptyContactSalesRoleRelation type: string format: uuid ContactGetById200Response14: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' ContactUpdateGhostLeadOpptyContactSalesRoleRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' ContactListDefinedRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ContactCreateNewGhostLeadOpptyContactSalesRoleRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' ContactRemoveBatchGhostLeadOpptySalesRoleRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted GhostLeadOpptyContactSalesRoleRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ContactModifyBatchGhostLeadOpptySalesRoleRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ImportMappingMaskremoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ImportMappingMask type: string format: uuid ImportMappingMaskGetResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ImportMappingMask' ImportModifyMappingMaskResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ImportMappingMask' ImportMappingMasksListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ImportMappingMask' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ImportMappingMaskCreateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ImportMappingMask' ImportMappingMasksremoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ImportMappingMask. type: string format: uuid - $ref: '#/components/schemas/Error' ImportMappingBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' InterfaceRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted InterfacePreview type: string format: uuid InterfaceGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/InterfacePreview' InterfaceModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/InterfacePreview' InterfaceGetAllPreviewsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/InterfacePreview' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true InterfaceGeneratePreviewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/InterfacePreview' InterfaceRemoveWithIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted InterfacePreview. type: string format: uuid - $ref: '#/components/schemas/Error' InterfaceModifyBatchInterfacePreviewsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveLeadByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Lead type: string format: uuid LeadOpportunityGetLeadByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Lead' LeadOpportunityModifyLeadResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Lead' LeadOpportunityGetAllLeadsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Lead' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityRegisterNewLeadResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Lead' LeadOpportunityRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Lead. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyBatchLeadsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOppty' LeadOpportunityGetAllLeadOpportunitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOppty' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyAccountRelation type: string format: uuid LeadOpportunityGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyAccountRelation' LeadOpportunityModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyAccountRelation' LeadOpportunityGetListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyAccountRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyAccountRelation' LeadOpportunityRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyAccountRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyBatchLeadOpptyAccountRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyContactGroupRelation type: string format: uuid LeadOpportunityGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' LeadOpportunityModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' LeadOpportunityGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' LeadOpportunityRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyContactGroupRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyLeadOpptyContactGroupRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyContactRelation type: string format: uuid LeadOpportunityGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactRelation' LeadOpportunityModifyRelation200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactRelation' LeadOpportunityGetAllRelations200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyContactRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewRelation201Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactRelation' LeadOpportunityRemoveByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyContactRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyBatchLeadOpptyContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyContactSalesRoleRelation type: string format: uuid LeadOpportunityGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' LeadOpportunityModifyContactSalesRoleRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' LeadOpportunityGetRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewLeadOpptyContactSalesRoleRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' LeadOpportunityRemoveRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyContactSalesRoleRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyDataExRelation' LeadOpportunityGetAllRelations200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyKPI type: string format: uuid LeadOpportunityGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyKPI' LeadOpportunityModifyKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyKPI' LeadOpportunityGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewLeadOpptyKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyKPI' LeadOpportunityRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyKPI. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModify200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptySharingClientRelation type: string format: uuid LeadOpportunityGetById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' LeadOpportunityModifyRelation200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' LeadOpportunityGetAllClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptySharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewRelation201Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' LeadOpportunityRemoveBatch200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptySharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptySharingSalesUnitRelation type: string format: uuid LeadOpportunityGetSalesUnitRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' LeadOpportunityUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' LeadOpportunityGetRelations200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewRelation201Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' LeadOpportunityRemoveBatch200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptySharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifySalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadOpptyStepCheckListRelation type: string format: uuid LeadOpportunityGetRelationByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' LeadOpportunityModifyCheckListRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' LeadOpportunityGetAllRelations200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateChecklistRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' LeadOpportunityRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadOpptyStepCheckListRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveLeadProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadProcess type: string format: uuid LeadOpportunityGetLeadProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadProcess' LeadOpportunityModifyLeadProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadProcess' LeadOpportunityGetAllProcessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadProcess' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateLeadProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadProcess' LeadOpportunityRemoveBatch200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadProcess. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyLeadProcessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted LeadType type: string format: uuid LeadOpportunityGetLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadType' LeadOpportunityModifyLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadType' LeadOpportunityGetLeadTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/LeadType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateLeadTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/LeadType' LeadOpportunityRemoveBatch200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted LeadType. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyLeadTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted MasterRight type: string format: uuid MasterRightGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MasterRight' MasterRightModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MasterRight' MasterRightListAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/MasterRight' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MasterRightGenerateNewMasterRightResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MasterRight' MasterRightRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted MasterRight. type: string format: uuid - $ref: '#/components/schemas/Error' MasterRightModifyBatchMasterRightsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MemoRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Memo type: string format: uuid MemoGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Memo' MemoModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Memo' MemoGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Memo' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MemoAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Memo' MemoRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Memo. type: string format: uuid - $ref: '#/components/schemas/Error' MemoBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MemoRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted MemoComment type: string format: uuid MemoGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MemoComment' MemoUpdateMemoCommentResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MemoComment' MemoGetAllMemoCommentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/MemoComment' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MemoCreateNewMemoCommentResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MemoComment' MemoRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted MemoComment. type: string format: uuid - $ref: '#/components/schemas/Error' MemoModifyBatchMemoCommentsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MessageRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted MessageRelation type: string format: uuid MessageGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageRelation' MessageModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageRelation' MessageGetAllMessageRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/MessageRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MessageCreateNewMessageRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageRelation' MessageRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted MessageRelation. type: string format: uuid - $ref: '#/components/schemas/Error' MessageModifyBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MessageRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted MessageSharingClientRelation type: string format: uuid MessageGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingClientRelation' MessageUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingClientRelation' MessageGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/MessageSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MessageCreateNewRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingClientRelation' MessageRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted MessageSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' MessageCreateOrUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' MessageRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted MessageSharingSalesUnitRelation type: string format: uuid MessageGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingSalesUnitRelation' MessageUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingSalesUnitRelation' MessageListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/MessageSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true MessageCreateNewRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/MessageSharingSalesUnitRelation' MessageRemoveBatchMessageSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted MessageSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' MessageUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' NoteRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Note type: string format: uuid NoteGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Note' NoteModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Note' NoteGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Note' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true NoteAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Note' NoteRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Note. type: string format: uuid - $ref: '#/components/schemas/Error' NoteBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineForm type: string format: uuid OnlineGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineForm' OnlineModifyFormByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineForm' OnlineGetAllFormsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineForm' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateNewFormResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineForm' OnlineRemoveBatchOnlineFormsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineForm. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineModifyBatchOnlineFormsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineFormActivityLogLine type: string format: uuid OnlineActivityLogGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormActivityLogLine' OnlineModifyLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormActivityLogLine' OnlineListActivityLogLinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineFormActivityLogLine' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateNewLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormActivityLogLine' OnlineRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineFormActivityLogLine. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineActivityBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineFormDataExRelation type: string format: uuid OnlineFormDataExRelationsGetResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormDataExRelation' OnlineModifyFormDataExRelationsByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormDataExRelation' OnlineGetRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineFormDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateFormRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormDataExRelation' OnlineRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineFormDataExRelation. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineCreateOrUpdateBatchOnlineFormDataExRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineFormRelation type: string format: uuid OnlineGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormRelation' OnlineModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormRelation' OnlineGetAllOnlineFormRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineFormRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormRelation' OnlineRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineFormRelation. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineModifyFormRelationsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineFormType type: string format: uuid OnlineGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormType' OnlineModifyFormTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormType' OnlineGetAllOnlineFormTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineFormType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateFormTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormType' OnlineRemoveByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineFormType. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineModifyFormBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OnlineFormTypeEmailRelation type: string format: uuid OnlineFormTypeEmailgetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' OnlineUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' OnlineListOnlineFormTypeEmailRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true OnlineCreateNewOnlineFormTypeEmailRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' OnlineRemoveBatchEmailRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OnlineFormTypeEmailRelation. type: string format: uuid - $ref: '#/components/schemas/Error' OnlineFormTypeEmailRelationsBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Opportunity type: string format: uuid LeadOpportunityGetById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Opportunity' LeadOpportunityModifyOpportunityResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Opportunity' LeadOpportunityGetAllOpportunitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Opportunity' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpportunityResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Opportunity' LeadOpportunityRemoveBatchOpportunitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Opportunity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpportunityType type: string format: uuid LeadOpportunityGetById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpportunityType' LeadOpportunityModifyOpportunityTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpportunityType' LeadOpportunityGetAllOpportunityTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpportunityType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpportunityTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpportunityType' LeadOpportunityRemoveBatchOpportunityTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpportunityType. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyOpportunityTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductLineItemsRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyProductRelation type: string format: uuid ProductLineItemsGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelation' ProductLineItemsModifyOpptyProductRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelation' ProductLineItemsGetAllOpptyProductRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyProductRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductLineItemsCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelation' ProductLineItemsRemoveBatchOpptyProductRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyProductRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ProductLineItemsBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyProductRelationDataExRelation type: string format: uuid LeadOpportunityGetProductRelationDataExRelationByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' LeadOpportunityUpdateRelationDataExResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' LeadOpportunityGetAllOpptyProductRelationDataExRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateOpptyProductRelationDataExRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' LeadOpportunityRemoveRelationsByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyProductRelationDataExRelation. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyProductRelationRevenueSchedule type: string format: uuid LeadOpportunityGetOpptyProductRelationRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' LeadOpportunityUpdateRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' LeadOpportunityGetAllOpptyProductRelationRevenueSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpptyProductRelationRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyProductRelationRevenueSchedule. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response11: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyProductRelationRevenueSchedulePeriod type: string format: uuid LeadOpportunityGetRevenueSchedulePeriodByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' LeadOpportunityUpdatePeriodResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' LeadOpportunityListOpptyProductRelationRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpptyProductRelationRevenueSchedulePeriodResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' LeadOpportunityRemoveBatchOpptyProductRelationRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyProductRelationRevenueSchedulePeriod. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyOpptyProductRelationRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response12: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyProductRelationType type: string format: uuid LeadOpportunityGetOpptyProductRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationType' LeadOpportunityModifyOpptyProductRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationType' LeadOpportunityGetList200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyProductRelationType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpptyProductRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyProductRelationType' LeadOpportunityRemoveByIds200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyProductRelationType. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyOpptyProductRelationTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveOpptyRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyRecurrence type: string format: uuid LeadOpportunityGetOpptyRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRecurrence' LeadOpportunityUpdateOpptyRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRecurrence' LeadOpportunityGetAllOpptyRecurrencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyRecurrence' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateOpptyRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRecurrence' LeadOpportunityRemoveByIds200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyRecurrence. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyOpptyRecurrencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveOpptyRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyRevenueSchedule type: string format: uuid LeadOpportunityGetById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedule' LeadOpportunityModifyOpptyRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedule' LeadOpportunityGetAllOpptyRevenueSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyRevenueSchedule' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateOpptyRevenueScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedule' LeadOpportunityRemoveBatch200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyRevenueSchedule. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityModifyBatchOpptyRevenueSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityRemoveById200Response13: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted OpptyRevenueSchedulePeriod type: string format: uuid LeadOpportunityGetOpptyRevenueSchedulePeriodResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' LeadOpportunityUpdateOpptyRevenueSchedulePeriodResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' LeadOpportunityGetAllOpptyRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true LeadOpportunityCreateNewOpptyRevenueSchedulePeriodResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' LeadOpportunityRemoveBatchOpptyRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted OpptyRevenueSchedulePeriod. type: string format: uuid - $ref: '#/components/schemas/Error' LeadOpportunityBatchModifyOpptyRevenueSchedulePeriodsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' AccountRemoveById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ParentAccountRelationType type: string format: uuid AccountGetById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ParentAccountRelationType' AccountUpdateRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ParentAccountRelationType' AccountListParentAccountRelationTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ParentAccountRelationType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true AccountCreateNewParentAccountRelationTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ParentAccountRelationType' AccountRemoveParentAccountRelationTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ParentAccountRelationType. type: string format: uuid - $ref: '#/components/schemas/Error' AccountModifyParentAccountRelationTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' PhoneRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Phone type: string format: uuid PhoneGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Phone' PhoneModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Phone' PhoneGetAllPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Phone' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true PhoneRegisterNewPhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Phone' PhoneRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Phone. type: string format: uuid - $ref: '#/components/schemas/Error' PhoneBatchModifyPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' PipelineRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Pipeline type: string format: uuid PipelineGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Pipeline' PipelineModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Pipeline' PipelineGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Pipeline' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true PipelineRegisterNewPipelineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Pipeline' PipelineRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Pipeline. type: string format: uuid - $ref: '#/components/schemas/Error' PipelineBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Process type: string format: uuid ProcessGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Process' ProcessModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Process' ProcessGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Process' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProcessRegisterNewProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Process' ProcessRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Process. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessBatchModifyEntitiesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProcessActivityLog type: string format: uuid ProcessGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLog' ProcessModifyActivityLogResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLog' ProcessGetAllLogsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProcessActivityLog' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProcessCreateActivityLogResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLog' ProcessRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProcessActivityLog. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessModifyBatchActivityLogsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProcessActivityLogLine type: string format: uuid ProcessGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLogLine' ProcessModifyLogLinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLogLine' ProcessGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProcessActivityLogLine' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProcessCreateLogLineResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessActivityLogLine' ProcessRemoveByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProcessActivityLogLine. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessCreateOrUpdateBatchLogLinesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProcessTemplate type: string format: uuid ProcessGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessTemplate' ProcessModifyTemplateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessTemplate' ProcessGetAllTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProcessTemplate' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProcessCreateNewProcessTemplateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProcessTemplate' ProcessRemoveByIds200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProcessTemplate. type: string format: uuid - $ref: '#/components/schemas/Error' ProcessModifyBatchProcessTemplatesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Product type: string format: uuid ProductGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Product' ProductModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Product' ProductGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Product' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreateNewProductResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Product' ProductRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Product. type: string format: uuid - $ref: '#/components/schemas/Error' ProductBatchModifyProductsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProductCategory type: string format: uuid ProductGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductCategory' ProductModifyCategoryByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductCategory' ProductGetAllProductCategoriesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductCategory' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreateNewCategoryResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductCategory' ProductRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProductCategory. type: string format: uuid - $ref: '#/components/schemas/Error' ProductModifyProductCategoriesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductDataExRelation' ProductGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProductPipelineRelation type: string format: uuid ProductGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPipelineRelation' ProductUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPipelineRelation' ProductListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductPipelineRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPipelineRelation' ProductRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProductPipelineRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ProductModifyBatchProductPipelineRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProductPriceList type: string format: uuid ProductGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceList' ProductModifyPriceListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceList' ProductListProductPriceListsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductPriceList' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreateNewProductPriceListResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceList' ProductDeleteBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProductPriceList. type: string format: uuid - $ref: '#/components/schemas/Error' ProductModifyBatchProductPriceListsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProductPriceListPrice type: string format: uuid ProductGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceListPrice' ProductUpdatePriceListPricesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceListPrice' ProductGetAllPricesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductPriceListPrice' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreatePriceListPriceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductPriceListPrice' ProductRemoveBatchPricesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProductPriceListPrice. type: string format: uuid - $ref: '#/components/schemas/Error' ProductPriceListPricesBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProductRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProductType type: string format: uuid ProductGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductType' ProductModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductType' ProductGetAllProductTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProductType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProductCreateNewProductTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProductType' ProductRemoveBatch200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProductType. type: string format: uuid - $ref: '#/components/schemas/Error' ProductModifyBatchProductTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProfileGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Profile' ProfileGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Profile' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProfileGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProfileSharingClientRelation' ProfileGetAll200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProfileSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProfileGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProfileSharingSalesUnitRelation' ProfileListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProfileSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Project type: string format: uuid ProjectGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Project' ProjectModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Project' ProjectGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Project' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateNewProjectResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Project' ProjectRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Project. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectContactRelation type: string format: uuid ProjectGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectContactRelation' ProjectModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectContactRelation' ProjectGetAllProjectContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectContactRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectContactRelation' ProjectRemoveRelationsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectContactRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectModifyRelationsBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectGetExRelationByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectDataExRelation' ProjectGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectKPI type: string format: uuid ProjectGetKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectKPI' ProjectModifyKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectKPI' ProjectGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateNewProjectKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectKPI' ProjectRemoveBatchKpIsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectKPI. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectModifyBatchProjectKpIsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectObjective type: string format: uuid ProjectGetObjectivesByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectObjective' ProjectModifyObjectivesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectObjective' ProjectGetAllProjectObjectivesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectObjective' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateNewObjectiveResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectObjective' ProjectRemoveBatchProjectObjectivesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectObjective. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectModifyProjectObjectivesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectSharingClientRelation type: string format: uuid ProjectGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingClientRelation' ProjectModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingClientRelation' ProjectGetAll200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingClientRelation' ProjectRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectModifyBatchProjectSharingClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectSharingSalesUnitRelation type: string format: uuid ProjectGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' ProjectUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' ProjectListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateRelation201Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' ProjectRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ProjectType type: string format: uuid ProjectGetTypeByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectType' ProjectModifyById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectType' ProjectGetAllProjectTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ProjectType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ProjectCreateNewProjectTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ProjectType' ProjectRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ProjectType. type: string format: uuid - $ref: '#/components/schemas/Error' ProjectModifyBatchProjectTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Quote type: string format: uuid QuoteGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Quote' QuoteModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Quote' QuoteGetAllQuotesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Quote' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteRegisterNewQuoteResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Quote' QuoteRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Quote. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteAccountRelation type: string format: uuid QuoteGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteAccountRelation' QuoteModifyRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteAccountRelation' QuoteGetAllQuoteAccountRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteAccountRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteAccountRelation' QuoteRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteAccountRelation. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteModifyBatchQuoteAccountRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteContactRelation type: string format: uuid QuoteGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteContactRelation' QuoteModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteContactRelation' QuoteGetAllQuoteContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteContactRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateRelation201Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteContactRelation' QuoteRemoveBatchByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteContactRelation. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteModifyBatchQuoteContactRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteDataExRelation type: string format: uuid QuoteGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteDataExRelation' QuoteUpdateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteDataExRelation' QuoteGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteDataExRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateRelation201Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteDataExRelation' QuoteRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteDataExRelation. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteCreateOrUpdateBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteKPI type: string format: uuid QuoteGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteKPI' QuoteModifyKpiByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteKPI' QuoteGetAllKpisResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteKPI' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateNewKpiResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteKPI' QuoteRemoveBatch200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteKPI. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteCreateOrUpdateBatchQuoteKpIsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteProcess type: string format: uuid QuoteGetById200Response4: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteProcess' QuoteUpdateProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteProcess' QuoteGetAllProcessesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteProcess' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateQuoteProcessResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteProcess' QuoteRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteProcess. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteProcessBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteSharingClientRelation type: string format: uuid QuoteGetById200Response5: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingClientRelation' QuoteUpdateRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingClientRelation' QuoteGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateRelation201Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingClientRelation' QuoteRemoveBatch200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteCreateOrUpdateBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteSharingSalesUnitRelation type: string format: uuid QuoteGetById200Response6: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' QuoteUpdateRelation200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' QuoteListRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateRelation201Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' QuoteRemoveBatch200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteRemoveById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted QuoteType type: string format: uuid QuoteGetById200Response7: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteType' QuoteUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteType' QuoteGetAllQuoteTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/QuoteType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true QuoteCreateNewTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/QuoteType' QuoteRemoveByIds200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted QuoteType. type: string format: uuid - $ref: '#/components/schemas/Error' QuoteModifyBatchQuoteTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ReportGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Report' ReportGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Report' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ReportGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportFolder' ReportGetAllReportFoldersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ReportFolder' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ReportRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted ReportSchedule type: string format: uuid ReportGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportSchedule' ReportModifyScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportSchedule' ReportGetAllReportSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ReportSchedule' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ReportCreateNewReportScheduleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportSchedule' ReportRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted ReportSchedule. type: string format: uuid - $ref: '#/components/schemas/Error' ReportModifyBatchReportSchedulesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ReportGetById200Response2: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportSharingClientRelation' ReportGetAllClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ReportSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ReportGetById200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/ReportSharingSalesUnitRelation' ReportListSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/ReportSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true SalesRoleRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted SalesRole type: string format: uuid SalesRoleGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesRole' SalesRoleModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesRole' SalesRoleGetAllRolesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/SalesRole' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true SalesRoleCreateNewRoleResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesRole' SalesRoleRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted SalesRole. type: string format: uuid - $ref: '#/components/schemas/Error' SalesRoleModifyBatchSalesRolesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' SalesUnitRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted SalesUnit type: string format: uuid SalesUnitGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesUnit' SalesUnitModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesUnit' SalesUnitListAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/SalesUnit' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true SalesUnitGenerateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesUnit' SalesUnitRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted SalesUnit. type: string format: uuid - $ref: '#/components/schemas/Error' SalesUnitModifyBatchSalesUnitsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' SalesUnitGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/SalesUnitClientRelation' SalesUnitGetAllRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/SalesUnitClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true StepRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Step type: string format: uuid StepGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Step' StepModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Step' StepGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Step' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true StepAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Step' StepRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Step. type: string format: uuid - $ref: '#/components/schemas/Error' StepBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' StepRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted StepChecklist type: string format: uuid StepGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklist' StepModifyChecklistByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklist' StepGetAllStepChecklistsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/StepChecklist' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true StepCreateStepChecklistResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklist' StepRemoveBatchByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted StepChecklist. type: string format: uuid - $ref: '#/components/schemas/Error' StepModifyBatchChecklistsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' StepRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted StepChecklistSalesRoleRelation type: string format: uuid StepGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklistSalesRoleRelation' StepModifySalesRoleRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklistSalesRoleRelation' StepGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/StepChecklistSalesRoleRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true StepCreateRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/StepChecklistSalesRoleRelation' StepRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted StepChecklistSalesRoleRelation. type: string format: uuid - $ref: '#/components/schemas/Error' StepModifyBatchStepChecklistSalesRoleRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TagRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Tag type: string format: uuid TagGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Tag' TagModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Tag' TagGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Tag' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TagAddNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Tag' TagRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Tag. type: string format: uuid - $ref: '#/components/schemas/Error' TagBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TagRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TagRelation type: string format: uuid TagGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TagRelation' TagModifyTagRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TagRelation' TagGetAllTagRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TagRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TagCreateNewTagRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TagRelation' TagRemoveBatchTagRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TagRelation. type: string format: uuid - $ref: '#/components/schemas/Error' TagModifyBatchTagRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TargetRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Target type: string format: uuid TargetGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Target' TargetModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Target' TargetGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Target' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TargetCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Target' TargetRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Target. type: string format: uuid - $ref: '#/components/schemas/Error' TargetBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TargetRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TargetRelation type: string format: uuid TargetGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TargetRelation' TargetModifyByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TargetRelation' TargetGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TargetRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TargetCreateNewRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TargetRelation' TargetRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TargetRelation. type: string format: uuid - $ref: '#/components/schemas/Error' TargetModifyBatchRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response8: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Task type: string format: uuid ActivityGetById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Task' ActivityModifyTaskResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Task' ActivityGetAllDefinedTasksResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Task' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityAddTaskResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Task' ActivityRemoveBatchTasksResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Task. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityBatchModifyTasksResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response9: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TaskRecurrence type: string format: uuid ActivityGetById200Response11: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskRecurrence' ActivityModifyTaskRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskRecurrence' ActivityGetAllTaskRecurrencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TaskRecurrence' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateTaskRecurrenceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskRecurrence' ActivityRemoveTaskRecurrencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TaskRecurrence. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyBatchTaskRecurrencesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveTaskReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TaskReminder type: string format: uuid ActivityGetTaskReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskReminder' ActivityModifyTaskReminderResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskReminder' ActivityGetAllTaskRemindersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TaskReminder' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityActionResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskReminder' ActivityRemoveTaskRemindersResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TaskReminder. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyTaskBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response10: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TaskSharingClientRelation type: string format: uuid ActivityGetTaskSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingClientRelation' ActivityModifyRelation200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingClientRelation' ActivityGetAllTaskSharingClientRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TaskSharingClientRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateNewTaskSharingClientRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingClientRelation' ActivityRemoveBatch200Response3: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TaskSharingClientRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityCreateOrUpdateBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response11: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TaskSharingSalesUnitRelation type: string format: uuid ActivityGetById200Response12: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingSalesUnitRelation' ActivityUpdateTaskSharingSalesUnitRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingSalesUnitRelation' ActivityListTaskSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TaskSharingSalesUnitRelation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateTaskSharingSalesUnitRelationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskSharingSalesUnitRelation' ActivityRemoveBatchTaskSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TaskSharingSalesUnitRelation. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityBatchCreateOrUpdateTaskSharingSalesUnitRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityRemoveById200Response12: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TaskType type: string format: uuid ActivityGetTaskTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskType' ActivityModifyTaskTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskType' ActivityGetAllTaskTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TaskType' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true ActivityCreateTaskTypeResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TaskType' ActivityRemoveBatchTaskTypesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TaskType. type: string format: uuid - $ref: '#/components/schemas/Error' ActivityModifyTaskTypesBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TextRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TextMessage type: string format: uuid TextGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessage' TextModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessage' TextGetAllTextMessagesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TextMessage' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TextCreateNewTextMessageResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessage' TextRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TextMessage. type: string format: uuid - $ref: '#/components/schemas/Error' TextModifyBatchTextMessagesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TextRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TextMessageConversation type: string format: uuid TextGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversation' TextModifyConversationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversation' TextGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TextMessageConversation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TextCreateConversationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversation' TextRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TextMessageConversation. type: string format: uuid - $ref: '#/components/schemas/Error' TextCreateOrUpdateBatchTextMessageConversationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TextRemoveById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted TextMessageConversationRelations type: string format: uuid TextGetById200Response1: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversationRelations' TextUpdateByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversationRelations' TextListTextMessageConversationRelationsesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/TextMessageConversationRelations' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TextCreateRelationsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/TextMessageConversationRelations' TextRemoveByIdsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted TextMessageConversationRelations. type: string format: uuid - $ref: '#/components/schemas/Error' TextBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TimeframeGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Timeframe' TimeframeListAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Timeframe' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TranslationRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Translation type: string format: uuid TranslationGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Translation' TranslationModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Translation' TranslationGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Translation' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true TranslationCreateNewTranslationResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Translation' TranslationRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Translation. type: string format: uuid - $ref: '#/components/schemas/Error' TranslationBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' TypeGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Type' TypeGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Type' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true UnsubscribedRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted UnsubscribedPhone type: string format: uuid UnsubscribedGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/UnsubscribedPhone' UnsubscribedUpdatePhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/UnsubscribedPhone' UnsubscribedGetAllPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/UnsubscribedPhone' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true UnsubscribedRegisterNewPhoneResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/UnsubscribedPhone' UnsubscribedRemoveBatchPhonesResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted UnsubscribedPhone. type: string format: uuid - $ref: '#/components/schemas/Error' UnsubscribedProcessBatchCreateOrUpdateResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' WebhookRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Webhook type: string format: uuid WebhookGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webhook' WebhookModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webhook' WebhookGetAllDefinedResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Webhook' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true WebhookCreateNewResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webhook' WebhookRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Webhook. type: string format: uuid - $ref: '#/components/schemas/Error' WebhookBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' WebhookRemoveById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted WebhookEvent type: string format: uuid WebhookGetById200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/WebhookEvent' WebhookModifyEventResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/WebhookEvent' WebhookGetAllEventsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/WebhookEvent' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true WebhookCreateNewEventResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/WebhookEvent' WebhookRemoveBatch200Response: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted WebhookEvent. type: string format: uuid - $ref: '#/components/schemas/Error' WebhookBatchModifyEventsResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' WebresourceRemoveByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: description: id of deleted Webresource type: string format: uuid WebresourceGetByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webresource' WebresourceModifyByIdResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webresource' WebresourceGetAllResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: $ref: '#/components/schemas/Webresource' page_info: description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. type: object properties: start_cursor: description: Start cursor of result set. type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== end_cursor: description: End cursor of result set. type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== has_previous_page: description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). type: boolean example: true has_next_page: description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it). type: boolean example: true WebresourceCreateNewWebresourceResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: $ref: '#/components/schemas/Webresource' WebresourceRemoveBatchResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: An id of deleted Webresource. type: string format: uuid - $ref: '#/components/schemas/Error' WebresourceBatchModifyResponse: type: object properties: success: description: True when response succeeded, false on error. type: boolean example: true data: type: array items: oneOf: - description: And ID of created / updated entity. type: string format: uuid - $ref: '#/components/schemas/Error' x-stoplight: id: ra182dvlaisyv