openapi: 3.2.0 info: title: Pipeliner Cloud Lead & Opportunity API version: '100' servers: - url: https://us-east.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://eu-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ca-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ap-southeast.api.pipelinersales.com/api/v100/rest/spaces/{space_id} tags: - name: Lead & Opportunity paths: /entities/Leads/{id}: get: description: Returns Lead with given id operationId: Leads.get summary: Leads.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of Lead to retrieve required: true schema: type: string format: uuid responses: '200': description: Lead data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Lead' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes Lead with given id operationId: Leads.delete summary: Leads.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of Lead to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Lead on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted Lead type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies Lead or Leads with given id(s) parameters: - name: id in: path description: ID of Lead to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Lead on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: Leads.update summary: Leads.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadInput' responses: '200': description: Modification confirmation. Returns resulting Lead content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Lead' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Leads: get: description: Returns all defined Leads operationId: Leads.list summary: Leads.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted Leads are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Leads content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/Lead' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new Lead operationId: Leads.create summary: Leads.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Lead on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new Lead required: true content: application / json: schema: $ref: '#/components/schemas/createLeadInput' responses: '201': description: Creation confirmation. Returns created Lead content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Lead' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Leads/batch-delete: post: description: Removes Leads with given list of ids operationId: Leads.batch_delete summary: Leads.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Leads on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity Lead to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted Lead. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Leads/batch-modify: post: description: Create or update an batch of Leads operationId: Leads.batch_create_or_update summary: Leads.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Leads on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Lead required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Leads content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Leads/batch-restore: post: description: Restores Leads with given list of ids operationId: Leads.batch_restore summary: Leads.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Leads on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity Lead to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored Lead. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOppties/{id}: get: description: Returns LeadOppty with given id operationId: LeadOppties.get summary: LeadOppties.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOppty to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOppty data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOppty' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOppties: get: description: Returns all defined LeadOppties operationId: LeadOppties.list summary: LeadOppties.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOppties are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOppties content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOppty' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyAccountRelations/{id}: get: description: Returns LeadOpptyAccountRelation with given id operationId: LeadOpptyAccountRelations.get summary: LeadOpptyAccountRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyAccountRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyAccountRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyAccountRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyAccountRelation with given id operationId: LeadOpptyAccountRelations.delete summary: LeadOpptyAccountRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyAccountRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyAccountRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyAccountRelation or LeadOpptyAccountRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptyAccountRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyAccountRelations.update summary: LeadOpptyAccountRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyAccountRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyAccountRelations: get: description: Returns all defined LeadOpptyAccountRelations operationId: LeadOpptyAccountRelations.list summary: LeadOpptyAccountRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyAccountRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyAccountRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyAccountRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyAccountRelation operationId: LeadOpptyAccountRelations.create summary: LeadOpptyAccountRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyAccountRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyAccountRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyAccountRelations/batch-delete: post: description: Removes LeadOpptyAccountRelations with given list of ids operationId: LeadOpptyAccountRelations.batch_delete summary: LeadOpptyAccountRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyAccountRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyAccountRelations/batch-modify: post: description: Create or update an batch of LeadOpptyAccountRelations operationId: LeadOpptyAccountRelations.batch_create_or_update summary: LeadOpptyAccountRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyAccountRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyAccountRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyAccountRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyAccountRelations/batch-restore: post: description: Restores LeadOpptyAccountRelations with given list of ids operationId: LeadOpptyAccountRelations.batch_restore summary: LeadOpptyAccountRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyAccountRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyAccountRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactGroupRelations/{id}: get: description: Returns LeadOpptyContactGroupRelation with given id operationId: LeadOpptyContactGroupRelations.get summary: LeadOpptyContactGroupRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactGroupRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactGroupRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyContactGroupRelation with given id operationId: LeadOpptyContactGroupRelations.delete summary: LeadOpptyContactGroupRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactGroupRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyContactGroupRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyContactGroupRelation or LeadOpptyContactGroupRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptyContactGroupRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyContactGroupRelations.update summary: LeadOpptyContactGroupRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyContactGroupRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyContactGroupRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactGroupRelations: get: description: Returns all defined LeadOpptyContactGroupRelations operationId: LeadOpptyContactGroupRelations.list summary: LeadOpptyContactGroupRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyContactGroupRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactGroupRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyContactGroupRelation operationId: LeadOpptyContactGroupRelations.create summary: LeadOpptyContactGroupRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactGroupRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyContactGroupRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyContactGroupRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactGroupRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactGroupRelations/batch-delete: post: description: Removes LeadOpptyContactGroupRelations with given list of ids operationId: LeadOpptyContactGroupRelations.batch_delete summary: LeadOpptyContactGroupRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactGroupRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyContactGroupRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactGroupRelations/batch-modify: post: description: Create or update an batch of LeadOpptyContactGroupRelations operationId: LeadOpptyContactGroupRelations.batch_create_or_update summary: LeadOpptyContactGroupRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactGroupRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactGroupRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyContactGroupRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactGroupRelations/batch-restore: post: description: Restores LeadOpptyContactGroupRelations with given list of ids operationId: LeadOpptyContactGroupRelations.batch_restore summary: LeadOpptyContactGroupRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactGroupRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactGroupRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyContactGroupRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactRelations/{id}: get: description: Returns LeadOpptyContactRelation with given id operationId: LeadOpptyContactRelations.get summary: LeadOpptyContactRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyContactRelation with given id operationId: LeadOpptyContactRelations.delete summary: LeadOpptyContactRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyContactRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyContactRelation or LeadOpptyContactRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptyContactRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyContactRelations.update summary: LeadOpptyContactRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactRelations: get: description: Returns all defined LeadOpptyContactRelations operationId: LeadOpptyContactRelations.list summary: LeadOpptyContactRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyContactRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyContactRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyContactRelation operationId: LeadOpptyContactRelations.create summary: LeadOpptyContactRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyContactRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactRelations/batch-delete: post: description: Removes LeadOpptyContactRelations with given list of ids operationId: LeadOpptyContactRelations.batch_delete summary: LeadOpptyContactRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactRelations/batch-modify: post: description: Create or update an batch of LeadOpptyContactRelations operationId: LeadOpptyContactRelations.batch_create_or_update summary: LeadOpptyContactRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyContactRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactRelations/batch-restore: post: description: Restores LeadOpptyContactRelations with given list of ids operationId: LeadOpptyContactRelations.batch_restore summary: LeadOpptyContactRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactSalesRoleRelations/{id}: get: description: Returns LeadOpptyContactSalesRoleRelation with given id operationId: LeadOpptyContactSalesRoleRelations.get summary: LeadOpptyContactSalesRoleRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactSalesRoleRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyContactSalesRoleRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyContactSalesRoleRelation with given id operationId: LeadOpptyContactSalesRoleRelations.delete summary: LeadOpptyContactSalesRoleRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyContactSalesRoleRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyContactSalesRoleRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyContactSalesRoleRelation or LeadOpptyContactSalesRoleRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptyContactSalesRoleRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyContactSalesRoleRelations.update summary: LeadOpptyContactSalesRoleRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyContactSalesRoleRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyContactSalesRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactSalesRoleRelations: get: description: Returns all defined LeadOpptyContactSalesRoleRelations operationId: LeadOpptyContactSalesRoleRelations.list summary: LeadOpptyContactSalesRoleRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyContactSalesRoleRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyContactSalesRoleRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyContactSalesRoleRelation operationId: LeadOpptyContactSalesRoleRelations.create summary: LeadOpptyContactSalesRoleRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyContactSalesRoleRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyContactSalesRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyContactSalesRoleRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactSalesRoleRelations/batch-delete: post: description: Removes LeadOpptyContactSalesRoleRelations with given list of ids operationId: LeadOpptyContactSalesRoleRelations.batch_delete summary: LeadOpptyContactSalesRoleRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactSalesRoleRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyContactSalesRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactSalesRoleRelations/batch-modify: post: description: Create or update an batch of LeadOpptyContactSalesRoleRelations operationId: LeadOpptyContactSalesRoleRelations.batch_create_or_update summary: LeadOpptyContactSalesRoleRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyContactSalesRoleRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyContactSalesRoleRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyContactSalesRoleRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyContactSalesRoleRelations/batch-restore: post: description: Restores LeadOpptyContactSalesRoleRelations with given list of ids operationId: LeadOpptyContactSalesRoleRelations.batch_restore summary: LeadOpptyContactSalesRoleRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyContactSalesRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyContactSalesRoleRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyContactSalesRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyDataExRelations/{id}: get: description: Returns LeadOpptyDataExRelation with given id operationId: LeadOpptyDataExRelations.get summary: LeadOpptyDataExRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyDataExRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyDataExRelations: get: description: Returns all defined LeadOpptyDataExRelations operationId: LeadOpptyDataExRelations.list summary: LeadOpptyDataExRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyDataExRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyDataExRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyKPIs/{id}: get: description: Returns LeadOpptyKPI with given id operationId: LeadOpptyKPIs.get summary: LeadOpptyKPIs.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyKPI to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyKPI data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyKPI with given id operationId: LeadOpptyKPIs.delete summary: LeadOpptyKPIs.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyKPI to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPI on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyKPI type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyKPI or LeadOpptyKPIs with given id(s) parameters: - name: id in: path description: ID of LeadOpptyKPI to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPI on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyKPIs.update summary: LeadOpptyKPIs.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyKPIInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyKPIs: get: description: Returns all defined LeadOpptyKPIs operationId: LeadOpptyKPIs.list summary: LeadOpptyKPIs.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyKPIs are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyKPI' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyKPI operationId: LeadOpptyKPIs.create summary: LeadOpptyKPIs.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPI on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyKPI required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyKPIInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyKPI' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyKPIs/batch-delete: post: description: Removes LeadOpptyKPIs with given list of ids operationId: LeadOpptyKPIs.batch_delete summary: LeadOpptyKPIs.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPIs on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyKPI to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyKPIs/batch-modify: post: description: Create or update an batch of LeadOpptyKPIs operationId: LeadOpptyKPIs.batch_create_or_update summary: LeadOpptyKPIs.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPIs on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyKPI required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyKPIInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyKPIs/batch-restore: post: description: Restores LeadOpptyKPIs with given list of ids operationId: LeadOpptyKPIs.batch_restore summary: LeadOpptyKPIs.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyKPIs on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyKPI to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingClientRelations/{id}: get: description: Returns LeadOpptySharingClientRelation with given id operationId: LeadOpptySharingClientRelations.get summary: LeadOpptySharingClientRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptySharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptySharingClientRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptySharingClientRelation with given id operationId: LeadOpptySharingClientRelations.delete summary: LeadOpptySharingClientRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptySharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptySharingClientRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptySharingClientRelation or LeadOpptySharingClientRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptySharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptySharingClientRelations.update summary: LeadOpptySharingClientRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptySharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptySharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingClientRelations: get: description: Returns all defined LeadOpptySharingClientRelations operationId: LeadOpptySharingClientRelations.list summary: LeadOpptySharingClientRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptySharingClientRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptySharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptySharingClientRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptySharingClientRelation operationId: LeadOpptySharingClientRelations.create summary: LeadOpptySharingClientRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptySharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptySharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingClientRelations/batch-delete: post: description: Removes LeadOpptySharingClientRelations with given list of ids operationId: LeadOpptySharingClientRelations.batch_delete summary: LeadOpptySharingClientRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptySharingClientRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptySharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingClientRelations/batch-modify: post: description: Create or update an batch of LeadOpptySharingClientRelations operationId: LeadOpptySharingClientRelations.batch_create_or_update summary: LeadOpptySharingClientRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptySharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptySharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingClientRelations/batch-restore: post: description: Restores LeadOpptySharingClientRelations with given list of ids operationId: LeadOpptySharingClientRelations.batch_restore summary: LeadOpptySharingClientRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptySharingClientRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptySharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingSalesUnitRelations/{id}: get: description: Returns LeadOpptySharingSalesUnitRelation with given id operationId: LeadOpptySharingSalesUnitRelations.get summary: LeadOpptySharingSalesUnitRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptySharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptySharingSalesUnitRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptySharingSalesUnitRelation with given id operationId: LeadOpptySharingSalesUnitRelations.delete summary: LeadOpptySharingSalesUnitRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptySharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptySharingSalesUnitRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptySharingSalesUnitRelation or LeadOpptySharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptySharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptySharingSalesUnitRelations.update summary: LeadOpptySharingSalesUnitRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptySharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptySharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingSalesUnitRelations: get: description: Returns all defined LeadOpptySharingSalesUnitRelations operationId: LeadOpptySharingSalesUnitRelations.list summary: LeadOpptySharingSalesUnitRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptySharingSalesUnitRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptySharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptySharingSalesUnitRelation operationId: LeadOpptySharingSalesUnitRelations.create summary: LeadOpptySharingSalesUnitRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptySharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptySharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptySharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingSalesUnitRelations/batch-delete: post: description: Removes LeadOpptySharingSalesUnitRelations with given list of ids operationId: LeadOpptySharingSalesUnitRelations.batch_delete summary: LeadOpptySharingSalesUnitRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptySharingSalesUnitRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptySharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of LeadOpptySharingSalesUnitRelations operationId: LeadOpptySharingSalesUnitRelations.batch_create_or_update summary: LeadOpptySharingSalesUnitRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptySharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptySharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptySharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptySharingSalesUnitRelations/batch-restore: post: description: Restores LeadOpptySharingSalesUnitRelations with given list of ids operationId: LeadOpptySharingSalesUnitRelations.batch_restore summary: LeadOpptySharingSalesUnitRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptySharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptySharingSalesUnitRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptySharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyStepCheckListRelations/{id}: get: description: Returns LeadOpptyStepCheckListRelation with given id operationId: LeadOpptyStepCheckListRelations.get summary: LeadOpptyStepCheckListRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyStepCheckListRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadOpptyStepCheckListRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadOpptyStepCheckListRelation with given id operationId: LeadOpptyStepCheckListRelations.delete summary: LeadOpptyStepCheckListRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadOpptyStepCheckListRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadOpptyStepCheckListRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadOpptyStepCheckListRelation or LeadOpptyStepCheckListRelations with given id(s) parameters: - name: id in: path description: ID of LeadOpptyStepCheckListRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadOpptyStepCheckListRelations.update summary: LeadOpptyStepCheckListRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadOpptyStepCheckListRelationInput' responses: '200': description: Modification confirmation. Returns resulting LeadOpptyStepCheckListRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyStepCheckListRelations: get: description: Returns all defined LeadOpptyStepCheckListRelations operationId: LeadOpptyStepCheckListRelations.list summary: LeadOpptyStepCheckListRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadOpptyStepCheckListRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadOpptyStepCheckListRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadOpptyStepCheckListRelation operationId: LeadOpptyStepCheckListRelations.create summary: LeadOpptyStepCheckListRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadOpptyStepCheckListRelation required: true content: application / json: schema: $ref: '#/components/schemas/createLeadOpptyStepCheckListRelationInput' responses: '201': description: Creation confirmation. Returns created LeadOpptyStepCheckListRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadOpptyStepCheckListRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyStepCheckListRelations/batch-delete: post: description: Removes LeadOpptyStepCheckListRelations with given list of ids operationId: LeadOpptyStepCheckListRelations.batch_delete summary: LeadOpptyStepCheckListRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyStepCheckListRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadOpptyStepCheckListRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyStepCheckListRelations/batch-modify: post: description: Create or update an batch of LeadOpptyStepCheckListRelations operationId: LeadOpptyStepCheckListRelations.batch_create_or_update summary: LeadOpptyStepCheckListRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadOpptyStepCheckListRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadOpptyStepCheckListRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadOpptyStepCheckListRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadOpptyStepCheckListRelations/batch-restore: post: description: Restores LeadOpptyStepCheckListRelations with given list of ids operationId: LeadOpptyStepCheckListRelations.batch_restore summary: LeadOpptyStepCheckListRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadOpptyStepCheckListRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadOpptyStepCheckListRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadOpptyStepCheckListRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadProcesses/{id}: get: description: Returns LeadProcess with given id operationId: LeadProcesses.get summary: LeadProcesses.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadProcess to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadProcess data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadProcess' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadProcess with given id operationId: LeadProcesses.delete summary: LeadProcesses.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadProcess to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadProcess on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadProcess type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadProcess or LeadProcesses with given id(s) parameters: - name: id in: path description: ID of LeadProcess to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadProcess on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadProcesses.update summary: LeadProcesses.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadProcessInput' responses: '200': description: Modification confirmation. Returns resulting LeadProcess content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadProcess' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadProcesses: get: description: Returns all defined LeadProcesses operationId: LeadProcesses.list summary: LeadProcesses.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadProcesses are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadProcesses content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadProcess' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadProcess operationId: LeadProcesses.create summary: LeadProcesses.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadProcess on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadProcess required: true content: application / json: schema: $ref: '#/components/schemas/createLeadProcessInput' responses: '201': description: Creation confirmation. Returns created LeadProcess content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadProcess' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadProcesses/batch-delete: post: description: Removes LeadProcesses with given list of ids operationId: LeadProcesses.batch_delete summary: LeadProcesses.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadProcesses on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadProcess to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadProcess. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadProcesses/batch-modify: post: description: Create or update an batch of LeadProcesses operationId: LeadProcesses.batch_create_or_update summary: LeadProcesses.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadProcesses on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadProcess required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadProcessInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadProcesses content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadProcesses/batch-restore: post: description: Restores LeadProcesses with given list of ids operationId: LeadProcesses.batch_restore summary: LeadProcesses.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadProcesses on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadProcess to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadProcess. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadTypes/{id}: get: description: Returns LeadType with given id operationId: LeadTypes.get summary: LeadTypes.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadType to retrieve required: true schema: type: string format: uuid responses: '200': description: LeadType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes LeadType with given id operationId: LeadTypes.delete summary: LeadTypes.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of LeadType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted LeadType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies LeadType or LeadTypes with given id(s) parameters: - name: id in: path description: ID of LeadType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of LeadType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: LeadTypes.update summary: LeadTypes.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateLeadTypeInput' responses: '200': description: Modification confirmation. Returns resulting LeadType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadTypes: get: description: Returns all defined LeadTypes operationId: LeadTypes.list summary: LeadTypes.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted LeadTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of LeadTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/LeadType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new LeadType operationId: LeadTypes.create summary: LeadTypes.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new LeadType required: true content: application / json: schema: $ref: '#/components/schemas/createLeadTypeInput' responses: '201': description: Creation confirmation. Returns created LeadType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/LeadType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadTypes/batch-delete: post: description: Removes LeadTypes with given list of ids operationId: LeadTypes.batch_delete summary: LeadTypes.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted LeadType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadTypes/batch-modify: post: description: Create or update an batch of LeadTypes operationId: LeadTypes.batch_create_or_update summary: LeadTypes.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new LeadType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchLeadTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated LeadTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/LeadTypes/batch-restore: post: description: Restores LeadTypes with given list of ids operationId: LeadTypes.batch_restore summary: LeadTypes.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of LeadTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity LeadType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored LeadType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Opportunities/{id}: get: description: Returns Opportunity with given id operationId: Opportunities.get summary: Opportunities.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of Opportunity to retrieve required: true schema: type: string format: uuid responses: '200': description: Opportunity data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Opportunity' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes Opportunity with given id operationId: Opportunities.delete summary: Opportunities.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of Opportunity to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Opportunity on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted Opportunity type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies Opportunity or Opportunities with given id(s) parameters: - name: id in: path description: ID of Opportunity to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Opportunity on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: Opportunities.update summary: Opportunities.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpportunityInput' responses: '200': description: Modification confirmation. Returns resulting Opportunity content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Opportunity' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Opportunities: get: description: Returns all defined Opportunities operationId: Opportunities.list summary: Opportunities.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted Opportunities are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Opportunities content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/Opportunity' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new Opportunity operationId: Opportunities.create summary: Opportunities.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Opportunity on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new Opportunity required: true content: application / json: schema: $ref: '#/components/schemas/createOpportunityInput' responses: '201': description: Creation confirmation. Returns created Opportunity content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Opportunity' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Opportunities/batch-delete: post: description: Removes Opportunities with given list of ids operationId: Opportunities.batch_delete summary: Opportunities.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Opportunities on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity Opportunity to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted Opportunity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Opportunities/batch-modify: post: description: Create or update an batch of Opportunities operationId: Opportunities.batch_create_or_update summary: Opportunities.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Opportunities on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Opportunity required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpportunityInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Opportunities content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Opportunities/batch-restore: post: description: Restores Opportunities with given list of ids operationId: Opportunities.batch_restore summary: Opportunities.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of Opportunities on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity Opportunity to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored Opportunity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpportunityTypes/{id}: get: description: Returns OpportunityType with given id operationId: OpportunityTypes.get summary: OpportunityTypes.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpportunityType to retrieve required: true schema: type: string format: uuid responses: '200': description: OpportunityType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpportunityType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpportunityType with given id operationId: OpportunityTypes.delete summary: OpportunityTypes.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpportunityType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpportunityType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpportunityType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpportunityType or OpportunityTypes with given id(s) parameters: - name: id in: path description: ID of OpportunityType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpportunityType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpportunityTypes.update summary: OpportunityTypes.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpportunityTypeInput' responses: '200': description: Modification confirmation. Returns resulting OpportunityType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpportunityType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpportunityTypes: get: description: Returns all defined OpportunityTypes operationId: OpportunityTypes.list summary: OpportunityTypes.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpportunityTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpportunityTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpportunityType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpportunityType operationId: OpportunityTypes.create summary: OpportunityTypes.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpportunityType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpportunityType required: true content: application / json: schema: $ref: '#/components/schemas/createOpportunityTypeInput' responses: '201': description: Creation confirmation. Returns created OpportunityType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpportunityType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpportunityTypes/batch-delete: post: description: Removes OpportunityTypes with given list of ids operationId: OpportunityTypes.batch_delete summary: OpportunityTypes.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpportunityTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpportunityType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpportunityType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpportunityTypes/batch-modify: post: description: Create or update an batch of OpportunityTypes operationId: OpportunityTypes.batch_create_or_update summary: OpportunityTypes.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpportunityTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpportunityType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpportunityTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpportunityTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpportunityTypes/batch-restore: post: description: Restores OpportunityTypes with given list of ids operationId: OpportunityTypes.batch_restore summary: OpportunityTypes.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpportunityTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpportunityType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpportunityType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationDataExRelations/{id}: get: description: Returns OpptyProductRelationDataExRelation with given id operationId: OpptyProductRelationDataExRelations.get summary: OpptyProductRelationDataExRelations.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationDataExRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyProductRelationDataExRelation with given id operationId: OpptyProductRelationDataExRelations.delete summary: OpptyProductRelationDataExRelations.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationDataExRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyProductRelationDataExRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyProductRelationDataExRelation or OpptyProductRelationDataExRelations with given id(s) parameters: - name: id in: path description: ID of OpptyProductRelationDataExRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyProductRelationDataExRelations.update summary: OpptyProductRelationDataExRelations.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationDataExRelationInput' responses: '200': description: Modification confirmation. Returns resulting OpptyProductRelationDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationDataExRelations: get: description: Returns all defined OpptyProductRelationDataExRelations operationId: OpptyProductRelationDataExRelations.list summary: OpptyProductRelationDataExRelations.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyProductRelationDataExRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyProductRelationDataExRelation operationId: OpptyProductRelationDataExRelations.create summary: OpptyProductRelationDataExRelations.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationDataExRelationInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelationDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationDataExRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationDataExRelations/batch-delete: post: description: Removes OpptyProductRelationDataExRelations with given list of ids operationId: OpptyProductRelationDataExRelations.batch_delete summary: OpptyProductRelationDataExRelations.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationDataExRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyProductRelationDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationDataExRelations/batch-modify: post: description: Create or update an batch of OpptyProductRelationDataExRelations operationId: OpptyProductRelationDataExRelations.batch_create_or_update summary: OpptyProductRelationDataExRelations.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationDataExRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationDataExRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyProductRelationDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationDataExRelations/batch-restore: post: description: Restores OpptyProductRelationDataExRelations with given list of ids operationId: OpptyProductRelationDataExRelations.batch_restore summary: OpptyProductRelationDataExRelations.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationDataExRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationDataExRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyProductRelationDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedules/{id}: get: description: Returns OpptyProductRelationRevenueSchedule with given id operationId: OpptyProductRelationRevenueSchedules.get summary: OpptyProductRelationRevenueSchedules.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedule to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationRevenueSchedule data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyProductRelationRevenueSchedule with given id operationId: OpptyProductRelationRevenueSchedules.delete summary: OpptyProductRelationRevenueSchedules.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedule to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedule on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyProductRelationRevenueSchedule type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyProductRelationRevenueSchedule or OpptyProductRelationRevenueSchedules with given id(s) parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedule to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyProductRelationRevenueSchedules.update summary: OpptyProductRelationRevenueSchedules.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationRevenueScheduleInput' responses: '200': description: Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedule content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedules: get: description: Returns all defined OpptyProductRelationRevenueSchedules operationId: OpptyProductRelationRevenueSchedules.list summary: OpptyProductRelationRevenueSchedules.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyProductRelationRevenueSchedules are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationRevenueSchedules content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyProductRelationRevenueSchedule operationId: OpptyProductRelationRevenueSchedules.create summary: OpptyProductRelationRevenueSchedules.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedule on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedule required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationRevenueScheduleInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelationRevenueSchedule content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedule' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedules/batch-delete: post: description: Removes OpptyProductRelationRevenueSchedules with given list of ids operationId: OpptyProductRelationRevenueSchedules.batch_delete summary: OpptyProductRelationRevenueSchedules.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedules on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationRevenueSchedule to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyProductRelationRevenueSchedule. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedules/batch-modify: post: description: Create or update an batch of OpptyProductRelationRevenueSchedules operationId: OpptyProductRelationRevenueSchedules.batch_create_or_update summary: OpptyProductRelationRevenueSchedules.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedules on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedule required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationRevenueScheduleInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedules content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedules/batch-restore: post: description: Restores OpptyProductRelationRevenueSchedules with given list of ids operationId: OpptyProductRelationRevenueSchedules.batch_restore summary: OpptyProductRelationRevenueSchedules.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedules on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationRevenueSchedule to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyProductRelationRevenueSchedule. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedulePeriods/{id}: get: description: Returns OpptyProductRelationRevenueSchedulePeriod with given id operationId: OpptyProductRelationRevenueSchedulePeriods.get summary: OpptyProductRelationRevenueSchedulePeriods.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedulePeriod to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationRevenueSchedulePeriod data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyProductRelationRevenueSchedulePeriod with given id operationId: OpptyProductRelationRevenueSchedulePeriods.delete summary: OpptyProductRelationRevenueSchedulePeriods.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedulePeriod to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriod on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyProductRelationRevenueSchedulePeriod type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyProductRelationRevenueSchedulePeriod or OpptyProductRelationRevenueSchedulePeriods with given id(s) parameters: - name: id in: path description: ID of OpptyProductRelationRevenueSchedulePeriod to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriod on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyProductRelationRevenueSchedulePeriods.update summary: OpptyProductRelationRevenueSchedulePeriods.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationRevenueSchedulePeriodInput' responses: '200': description: Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedulePeriod content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedulePeriods: get: description: Returns all defined OpptyProductRelationRevenueSchedulePeriods operationId: OpptyProductRelationRevenueSchedulePeriods.list summary: OpptyProductRelationRevenueSchedulePeriods.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyProductRelationRevenueSchedulePeriods are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationRevenueSchedulePeriods content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyProductRelationRevenueSchedulePeriod operationId: OpptyProductRelationRevenueSchedulePeriods.create summary: OpptyProductRelationRevenueSchedulePeriods.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriod on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedulePeriod required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationRevenueSchedulePeriodInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelationRevenueSchedulePeriod content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationRevenueSchedulePeriod' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedulePeriods/batch-delete: post: description: Removes OpptyProductRelationRevenueSchedulePeriods with given list of ids operationId: OpptyProductRelationRevenueSchedulePeriods.batch_delete summary: OpptyProductRelationRevenueSchedulePeriods.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriods on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationRevenueSchedulePeriod to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyProductRelationRevenueSchedulePeriod. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedulePeriods/batch-modify: post: description: Create or update an batch of OpptyProductRelationRevenueSchedulePeriods operationId: OpptyProductRelationRevenueSchedulePeriods.batch_create_or_update summary: OpptyProductRelationRevenueSchedulePeriods.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriods on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationRevenueSchedulePeriod required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationRevenueSchedulePeriodInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedulePeriods content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationRevenueSchedulePeriods/batch-restore: post: description: Restores OpptyProductRelationRevenueSchedulePeriods with given list of ids operationId: OpptyProductRelationRevenueSchedulePeriods.batch_restore summary: OpptyProductRelationRevenueSchedulePeriods.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationRevenueSchedulePeriods on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationRevenueSchedulePeriod to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyProductRelationRevenueSchedulePeriod. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationTypes/{id}: get: description: Returns OpptyProductRelationType with given id operationId: OpptyProductRelationTypes.get summary: OpptyProductRelationTypes.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationType to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyProductRelationType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyProductRelationType with given id operationId: OpptyProductRelationTypes.delete summary: OpptyProductRelationTypes.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyProductRelationType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyProductRelationType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyProductRelationType or OpptyProductRelationTypes with given id(s) parameters: - name: id in: path description: ID of OpptyProductRelationType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyProductRelationTypes.update summary: OpptyProductRelationTypes.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyProductRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting OpptyProductRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationTypes: get: description: Returns all defined OpptyProductRelationTypes operationId: OpptyProductRelationTypes.list summary: OpptyProductRelationTypes.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyProductRelationTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyProductRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyProductRelationType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyProductRelationType operationId: OpptyProductRelationTypes.create summary: OpptyProductRelationTypes.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyProductRelationTypeInput' responses: '201': description: Creation confirmation. Returns created OpptyProductRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyProductRelationType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationTypes/batch-delete: post: description: Removes OpptyProductRelationTypes with given list of ids operationId: OpptyProductRelationTypes.batch_delete summary: OpptyProductRelationTypes.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyProductRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationTypes/batch-modify: post: description: Create or update an batch of OpptyProductRelationTypes operationId: OpptyProductRelationTypes.batch_create_or_update summary: OpptyProductRelationTypes.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyProductRelationType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyProductRelationTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyProductRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyProductRelationTypes/batch-restore: post: description: Restores OpptyProductRelationTypes with given list of ids operationId: OpptyProductRelationTypes.batch_restore summary: OpptyProductRelationTypes.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyProductRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyProductRelationType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyProductRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRecurrences/{id}: get: description: Returns OpptyRecurrence with given id operationId: OpptyRecurrences.get summary: OpptyRecurrences.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRecurrence to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyRecurrence data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRecurrence' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyRecurrence with given id operationId: OpptyRecurrences.delete summary: OpptyRecurrences.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRecurrence to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRecurrence on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyRecurrence type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyRecurrence or OpptyRecurrences with given id(s) parameters: - name: id in: path description: ID of OpptyRecurrence to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRecurrence on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyRecurrences.update summary: OpptyRecurrences.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRecurrenceInput' responses: '200': description: Modification confirmation. Returns resulting OpptyRecurrence content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRecurrence' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRecurrences: get: description: Returns all defined OpptyRecurrences operationId: OpptyRecurrences.list summary: OpptyRecurrences.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyRecurrences are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRecurrences content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyRecurrence' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyRecurrence operationId: OpptyRecurrences.create summary: OpptyRecurrences.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRecurrence on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyRecurrence required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRecurrenceInput' responses: '201': description: Creation confirmation. Returns created OpptyRecurrence content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRecurrence' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRecurrences/batch-delete: post: description: Removes OpptyRecurrences with given list of ids operationId: OpptyRecurrences.batch_delete summary: OpptyRecurrences.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRecurrences on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRecurrence to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyRecurrence. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRecurrences/batch-modify: post: description: Create or update an batch of OpptyRecurrences operationId: OpptyRecurrences.batch_create_or_update summary: OpptyRecurrences.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRecurrences on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyRecurrence required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyRecurrenceInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyRecurrences content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRecurrences/batch-restore: post: description: Restores OpptyRecurrences with given list of ids operationId: OpptyRecurrences.batch_restore summary: OpptyRecurrences.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRecurrences on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRecurrence to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyRecurrence. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedules/{id}: get: description: Returns OpptyRevenueSchedule with given id operationId: OpptyRevenueSchedules.get summary: OpptyRevenueSchedules.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRevenueSchedule to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyRevenueSchedule data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedule' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyRevenueSchedule with given id operationId: OpptyRevenueSchedules.delete summary: OpptyRevenueSchedules.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRevenueSchedule to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedule on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyRevenueSchedule type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyRevenueSchedule or OpptyRevenueSchedules with given id(s) parameters: - name: id in: path description: ID of OpptyRevenueSchedule to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyRevenueSchedules.update summary: OpptyRevenueSchedules.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRevenueScheduleInput' responses: '200': description: Modification confirmation. Returns resulting OpptyRevenueSchedule content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedule' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedules: get: description: Returns all defined OpptyRevenueSchedules operationId: OpptyRevenueSchedules.list summary: OpptyRevenueSchedules.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyRevenueSchedules are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRevenueSchedules content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyRevenueSchedule' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyRevenueSchedule operationId: OpptyRevenueSchedules.create summary: OpptyRevenueSchedules.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedule on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedule required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRevenueScheduleInput' responses: '201': description: Creation confirmation. Returns created OpptyRevenueSchedule content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedule' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedules/batch-delete: post: description: Removes OpptyRevenueSchedules with given list of ids operationId: OpptyRevenueSchedules.batch_delete summary: OpptyRevenueSchedules.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedules on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRevenueSchedule to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyRevenueSchedule. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedules/batch-modify: post: description: Create or update an batch of OpptyRevenueSchedules operationId: OpptyRevenueSchedules.batch_create_or_update summary: OpptyRevenueSchedules.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedules on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedule required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyRevenueScheduleInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyRevenueSchedules content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedules/batch-restore: post: description: Restores OpptyRevenueSchedules with given list of ids operationId: OpptyRevenueSchedules.batch_restore summary: OpptyRevenueSchedules.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedules on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRevenueSchedule to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyRevenueSchedule. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedulePeriods/{id}: get: description: Returns OpptyRevenueSchedulePeriod with given id operationId: OpptyRevenueSchedulePeriods.get summary: OpptyRevenueSchedulePeriods.get tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRevenueSchedulePeriod to retrieve required: true schema: type: string format: uuid responses: '200': description: OpptyRevenueSchedulePeriod data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OpptyRevenueSchedulePeriod with given id operationId: OpptyRevenueSchedulePeriods.delete summary: OpptyRevenueSchedulePeriods.delete tags: - Lead & Opportunity parameters: - name: id in: path description: ID of OpptyRevenueSchedulePeriod to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriod on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted OpptyRevenueSchedulePeriod type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OpptyRevenueSchedulePeriod or OpptyRevenueSchedulePeriods with given id(s) parameters: - name: id in: path description: ID of OpptyRevenueSchedulePeriod to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriod on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: OpptyRevenueSchedulePeriods.update summary: OpptyRevenueSchedulePeriods.update tags: - Lead & Opportunity requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOpptyRevenueSchedulePeriodInput' responses: '200': description: Modification confirmation. Returns resulting OpptyRevenueSchedulePeriod content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedulePeriods: get: description: Returns all defined OpptyRevenueSchedulePeriods operationId: OpptyRevenueSchedulePeriods.list summary: OpptyRevenueSchedulePeriods.list tags: - Lead & Opportunity parameters: - name: include-deleted in: query description: if enabled, deleted OpptyRevenueSchedulePeriods are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OpptyRevenueSchedulePeriods content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OpptyRevenueSchedulePeriod operationId: OpptyRevenueSchedulePeriods.create summary: OpptyRevenueSchedulePeriods.create tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriod on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedulePeriod required: true content: application / json: schema: $ref: '#/components/schemas/createOpptyRevenueSchedulePeriodInput' responses: '201': description: Creation confirmation. Returns created OpptyRevenueSchedulePeriod content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OpptyRevenueSchedulePeriod' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedulePeriods/batch-delete: post: description: Removes OpptyRevenueSchedulePeriods with given list of ids operationId: OpptyRevenueSchedulePeriods.batch_delete summary: OpptyRevenueSchedulePeriods.batch_delete tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriods on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRevenueSchedulePeriod to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OpptyRevenueSchedulePeriod. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedulePeriods/batch-modify: post: description: Create or update an batch of OpptyRevenueSchedulePeriods operationId: OpptyRevenueSchedulePeriods.batch_create_or_update summary: OpptyRevenueSchedulePeriods.batch_create_or_update tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriods on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OpptyRevenueSchedulePeriod required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOpptyRevenueSchedulePeriodInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OpptyRevenueSchedulePeriods content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OpptyRevenueSchedulePeriods/batch-restore: post: description: Restores OpptyRevenueSchedulePeriods with given list of ids operationId: OpptyRevenueSchedulePeriods.batch_restore summary: OpptyRevenueSchedulePeriods.batch_restore tags: - Lead & Opportunity parameters: - name: validation-level in: query description: 'Specify validation level of OpptyRevenueSchedulePeriods on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OpptyRevenueSchedulePeriod to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OpptyRevenueSchedulePeriod. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: updateOpportunityTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing opportunities of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields. form_qualify: type: object description: JSON definition of the form shown when qualifying a lead into an opportunity of this type. form_won: type: object description: JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields. is_readonly: type: boolean example: false description: True when the opportunity type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. pipeline_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createLeadOpptySharingSalesUnitRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - lead_oppty_id - unit_id batchOpportunityTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing opportunities of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields. form_qualify: type: object description: JSON definition of the form shown when qualifying a lead into an opportunity of this type. form_won: type: object description: JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields. is_readonly: type: boolean example: false description: True when the opportunity type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. pipeline_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid Lead: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. 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.' lead_source: type: string format: uri description: 'How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. 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.' lead_type: type: string format: uri description: 'Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. 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.' owner: type: string format: uri description: 'Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. 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.' reason_of_close: type: string format: uri description: 'Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. 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.' step: type: string format: uri description: 'Step in the lead process the lead is currently in. 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.' unit: type: string format: uri description: 'Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. 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.' currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this lead. description: type: string example: string description: Free-form description of the lead. is_archived: type: boolean example: false description: True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the lead in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this lead. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead type. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead owner. quick_account_email: type: string example: string description: Free-text company email captured at lead creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at lead creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at lead creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at lead creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at lead creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at lead creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. reason_of_close_description: type: string example: string description: Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close. reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process step. table_name: type: string example: string description: Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results. readOnly: true unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. primary_contact: type: string format: uri description: 'Primary contact of this lead. Set automatically from the contact relation marked as primary. 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.' primary_account: type: string format: uri description: 'Primary account of this lead. Set automatically from the account relation marked as primary. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' contact_relations: type: array items: type: string format: uri description: 'Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptyContactRelation'' object for properties.' description: Contacts linked to this lead, including their roles and org-chart positions. account_relations: type: array items: type: string format: uri description: 'Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptyAccountRelation'' object for properties.' description: Accounts linked to this lead, including the primary-account flag. status: type: integer description: 'Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. Integer enum value: 1 - Open, 2 - Lost' example: 1 enum: - 1 - 2 readOnly: true sharing_units: type: array items: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptySharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptySharingClientRelation'' object for properties.' description: Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing. documents: type: array items: type: string format: uri description: 'Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObjectRelation'' object for properties.' description: Documents linked to this lead. tags: type: array items: type: string format: uri description: 'Relation to TagRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''TagRelation'' object for properties.' description: Tag labels applied to this lead. static_profiles: type: array items: type: string format: uri description: 'Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProfileRelation'' object for properties.' description: Saved view profiles this lead currently matches. qualify_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the lead was qualified, taken from the matching KPI event. Empty for leads that have not been qualified. Read-only. days_in_step: type: integer format: int32 example: 1 description: Number of days the lead has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this lead as favorite. Per-user. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. formatted_name: type: string example: string description: Display version of the lead name, used in lists and references. scoring: type: object description: Lead scoring summary, combining the percentile and current scoring state. Read-only; computed by Coevera. modified_by_user: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. required: - is_delete_protected - id - lead_type - step - unit - name - table_name - status - days_in_step - is_favorite - formatted_name batchOpptyRevenueScheduleInput: properties: is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the opportunity value is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for the opportunity begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateLeadOpptyContactSalesRoleRelationInput: properties: lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Lead/opportunity-contact link this sales-role assignment belongs to. Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity-contact link. sales_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales role. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. LeadType: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead_process: type: string format: uri description: 'Lead process (pipeline) this lead type follows. 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.' form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing leads of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving leads of this type. is_readonly: type: boolean example: false description: True when the lead type is system-managed and cannot be edited or deleted by users. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. form_lost_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. required: - id - lead_process - form_lost_enabled - is_readonly - lead_process_id - name - settings - has_draft - is_delete_protected - form_edit_api - form_lost_api batchOpptyRecurrenceInput: properties: apply_recurrence: type: boolean example: false description: Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply condition: type: string example: 1 enum: - 1 - 2 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." day: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: type: string example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." end_date: type: string format: date example: '2019-01-01' description: Date information. The last date when no more other items should be created. month: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: type: integer format: int32 example: 1 description: "Generic field wrapping sqlalchemy column, configurable by constructor.\n Good for one-of fields / generated fields.\n The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum." occurrences_count: type: integer format: int32 example: 1 description: Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent opportunity. start_date: type: string format: date example: '2019-01-01' description: Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: type: integer description: 'Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears' example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4' example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid OpptyProductRelationType: properties: has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. is_readonly: type: boolean example: false description: True when the line-item type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. product_type: type: string format: uri description: 'Product type paired with this line-item type. 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.' product_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the paired product type. Read-only. required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name - product_type - product_type_id LeadOpptySharingClientRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User the lead or opportunity is shared with. 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.' lead: type: string format: uri description: 'Lead being shared. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity being shared. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - client - client_id - lead_oppty_id updateOpptyProductRelationDataExRelationInput: properties: oppty_product_relation: type: object properties: id: type: string format: uri description: 'Product line item this enrichment record applies to. Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the external data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the enrichment record originates from. oppty_product_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product line item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. OpptyProductRelationDataExRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true data: type: string format: uri description: 'External data record (Data entity) holding the enrichment payload. 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.' oppty_product_relation: type: string format: uri description: 'Product line item this enrichment record applies to. 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.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the external data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the enrichment record originates from. oppty_product_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product line item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - data - oppty_product_relation - data_id - data_set_id - oppty_product_relation_id createLeadOpptySharingClientRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - client_id - lead_oppty_id createOpptyRecurrenceInput: properties: apply_recurrence: type: boolean example: false description: Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true condition: type: string example: 1 enum: - 1 - 2 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." day: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: type: string example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." end_date: type: string format: date example: '2019-01-01' description: Date information. The last date when no more other items should be created. month: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: type: integer format: int32 example: 1 description: "Generic field wrapping sqlalchemy column, configurable by constructor.\n Good for one-of fields / generated fields.\n The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum." occurrences_count: type: integer format: int32 example: 1 description: Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent opportunity. start_date: type: string format: date example: '2019-01-01' description: Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: type: integer description: 'Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears' example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4' example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - oppty_id - start_date - step_id createLeadOpptyContactSalesRoleRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Lead/opportunity-contact link this sales-role assignment belongs to. Relation to LeadOpptyContactRelation, see: ''createLeadOpptyContactRelationInput'' object for properties.' lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity-contact link. sales_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales role. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - sales_role_id createLeadOpptyKPIInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove. Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove' example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the KPI event relates to. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - kpi - lead_oppty_id - unit_id LeadOpptyContactSalesRoleRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead_oppty_contact_relation: type: string format: uri description: 'Lead/opportunity-contact link this sales-role assignment belongs to. 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.' sales_role: type: string format: uri description: 'Sales role assigned to the contact on this lead or opportunity. 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.' lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity-contact link. sales_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales role. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - sales_role - sales_role_id createLeadOpptyContactGroupRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' group_position: type: object description: 'Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }.' lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the contact group belongs to. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - color - group_position - lead_oppty_id - name batchLeadTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing leads of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving leads of this type. is_readonly: type: boolean example: false description: True when the lead type is system-managed and cannot be edited or deleted by users. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid 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 OpptyRecurrence: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty: type: string format: uri description: 'Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. 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.' step: type: string format: uri description: 'Pipeline step that newly generated opportunities are placed in. 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.' condition: type: string example: 1 enum: - 1 - 2 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." day: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: type: string example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." end_date: type: string format: date example: '2019-01-01' description: Date information. The last date when no more other items should be created. month: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: type: integer format: int32 example: 1 description: "Generic field wrapping sqlalchemy column, configurable by constructor.\n Good for one-of fields / generated fields.\n The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum." occurrences_count: type: integer format: int32 example: 1 description: Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent opportunity. start_date: type: string format: date example: '2019-01-01' description: Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: type: integer description: 'Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears' example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4' example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - oppty - oppty_id - start_date - step_id batchLeadProcessInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this lead process, in evaluation order. id: description: ID of object to update. type: string format: uuid LeadOpptyContactRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true contact: type: string format: uri description: 'Contact linked to the lead or opportunity. 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.' lead_oppty_contact_group_relation: type: string format: uri description: 'Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. 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.' lead: type: string format: uri description: 'Lead the contact is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity the contact is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' comment: type: string example: string description: Free-form note describing this contact link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. position_in_group: type: object description: 'Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }.' relationship: type: integer description: 'Org-chart relationship of the contact within the lead/opportunity hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong' example: 0 enum: - 0 - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sales_roles: type: array items: type: string format: uri description: 'Relation to LeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptyContactSalesRoleRelation'' object for properties.' description: Sales roles assigned to the contact for this lead or opportunity. required: - is_delete_protected - id - contact - contact_id - is_primary - lead_oppty_id createLeadInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this lead. description: type: string example: string description: Free-form description of the lead. is_archived: type: boolean example: false description: True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the lead in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this lead. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead type. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead owner. quick_account_email: type: string example: string description: Free-text company email captured at lead creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at lead creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at lead creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at lead creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at lead creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at lead creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. reason_of_close_description: type: string example: string description: Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close. reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''createLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this lead, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''createLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this lead, including the primary-account flag. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''createLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''createLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Documents linked to this lead. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''createTagRelationInput'' object for properties.' description: Tag labels applied to this lead. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''createProfileRelationInput'' object for properties.' description: Saved view profiles this lead currently matches. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. required: - name batchLeadOpptyContactGroupRelationInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' group_position: type: object description: 'Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }.' lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the contact group belongs to. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateOpptyRevenueSchedulePeriodInput: properties: oppty_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyRevenueSchedule, see: ''updateOpptyRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateLeadOpptyKPIInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove. Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove' example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the KPI event relates to. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. OpptyProductRelationRevenueSchedulePeriod: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty_product_relation_revenue_schedule: type: string format: uri description: 'Parent revenue schedule this period belongs to. 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.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_product_relation_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - oppty_product_relation_revenue_schedule - oppty_product_relation_revenue_schedule_id - transaction_id createLeadOpptyAccountRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - is_primary - lead_oppty_id LeadOpptyKPI: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record). 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.' lead: type: string format: uri description: 'Lead this KPI event relates to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity this KPI event relates to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' owner: type: string format: uri description: 'Lead/opportunity owner at the time the KPI event occurred. Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' unit: type: string format: uri description: 'Sales unit the triggering user belonged to at the time of the event. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''SalesUnit'' object for properties.' application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove. Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove' example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the KPI event relates to. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - unit - kpi - lead_oppty_id - unit_id updateLeadOpptyStepCheckListRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'Document linked as evidence for this checklist item. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' note: type: object properties: id: type: string format: uri description: 'Note linked as evidence for this checklist item. Relation to Note, see: ''updateNoteInput'' object for properties.' activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the appointment or task linked as evidence for this checklist item. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. item_checked: type: boolean example: false description: True when the checklist item has been completed for this lead, opportunity or quote. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity, or empty when this completion belongs to a quote. note_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the note. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. step_checklist_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the step checklist item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateOpptyProductRelationTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. is_readonly: type: boolean example: false description: True when the line-item type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateLeadInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this lead. description: type: string example: string description: Free-form description of the lead. is_archived: type: boolean example: false description: True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the lead in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this lead. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead type. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead owner. quick_account_email: type: string example: string description: Free-text company email captured at lead creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at lead creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at lead creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at lead creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at lead creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at lead creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. reason_of_close_description: type: string example: string description: Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close. reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this lead, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''updateLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this lead, including the primary-account flag. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''updateLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''updateLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this lead. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this lead. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this lead currently matches. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. createOpptyRevenueSchedulePeriodInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyRevenueSchedule, see: ''createOpptyRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - oppty_revenue_schedule - oppty_revenue_schedule_id - transaction_id updateOpptyRecurrenceInput: properties: apply_recurrence: type: boolean example: false description: Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply condition: type: string example: 1 enum: - 1 - 2 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." day: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: type: string example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 description: "Bit Flag field, with limited combination of integer values.\n \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." end_date: type: string format: date example: '2019-01-01' description: Date information. The last date when no more other items should be created. month: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: type: integer format: int32 example: 1 description: "Generic field wrapping sqlalchemy column, configurable by constructor.\n Good for one-of fields / generated fields.\n The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum." occurrences_count: type: integer format: int32 example: 1 description: Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent opportunity. start_date: type: string format: date example: '2019-01-01' description: Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step. type: type: integer description: 'Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears' example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: type: integer description: 'Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4' example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchOpptyProductRelationRevenueSchedulePeriodInput: properties: oppty_product_relation_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyProductRelationRevenueSchedule, see: ''updateOpptyProductRelationRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_product_relation_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchLeadOpptySharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchOpptyProductRelationDataExRelationInput: properties: oppty_product_relation: type: object properties: id: type: string format: uri description: 'Product line item this enrichment record applies to. Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the external data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the enrichment record originates from. oppty_product_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product line item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createLeadOpptyStepCheckListRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cloud_object: type: object properties: id: type: string format: uri description: 'Document linked as evidence for this checklist item. Relation to CloudObject, see: ''createCloudObjectInput'' object for properties.' note: type: object properties: id: type: string format: uri description: 'Note linked as evidence for this checklist item. Relation to Note, see: ''createNoteInput'' object for properties.' activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the appointment or task linked as evidence for this checklist item. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. item_checked: type: boolean example: false description: True when the checklist item has been completed for this lead, opportunity or quote. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity, or empty when this completion belongs to a quote. note_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the note. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. step_checklist_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the step checklist item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - step_checklist_id createLeadOpptyContactRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Relation to LeadOpptyContactGroupRelation, see: ''createLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-form note describing this contact link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. position_in_group: type: object description: 'Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }.' relationship: type: integer description: 'Org-chart relationship of the contact within the lead/opportunity hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong' example: 0 enum: - 0 - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sales_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactSalesRoleRelation, see: ''createLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the contact for this lead or opportunity. required: - contact_id - is_primary - lead_oppty_id updateLeadOpptyAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateOpptyRevenueScheduleInput: properties: is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the opportunity value is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for the opportunity begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createOpportunityTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing opportunities of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields. form_qualify: type: object description: JSON definition of the form shown when qualifying a lead into an opportunity of this type. form_won: type: object description: JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields. is_readonly: type: boolean example: false description: True when the opportunity type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. pipeline_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_readonly - name - pipeline_id - settings batchOpptyRevenueSchedulePeriodInput: properties: oppty_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyRevenueSchedule, see: ''updateOpptyRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateOpptyProductRelationRevenueScheduleInput: properties: is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the line-item amount is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for this product line begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchLeadInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this lead. description: type: string example: string description: Free-form description of the lead. is_archived: type: boolean example: false description: True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the lead in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this lead. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead type. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead owner. quick_account_email: type: string example: string description: Free-text company email captured at lead creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at lead creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at lead creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at lead creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at lead creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at lead creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. reason_of_close_description: type: string example: string description: Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close. reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this lead, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''updateLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this lead, including the primary-account flag. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''updateLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''updateLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this lead. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this lead. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this lead currently matches. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. id: description: ID of object to update. type: string format: uuid LeadOpptyAccountRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account linked to the lead or opportunity. 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.' lead: type: string format: uri description: 'Lead the account is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity the account is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - account_id - is_primary - lead_oppty_id LeadOppty: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true required: - is_delete_protected - id createLeadProcessInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this lead process, in evaluation order. required: - name - steps updateLeadProcessInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this lead process, in evaluation order. updateLeadTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing leads of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving leads of this type. is_readonly: type: boolean example: false description: True when the lead type is system-managed and cannot be edited or deleted by users. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. LeadProcess: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this lead process, in evaluation order. lead_types: type: array items: type: string format: uri description: 'Relation to LeadType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadType'' object for properties.' description: Lead types that follow this lead process. required: - is_delete_protected - id - name - steps - lead_types LeadOpptySharingSalesUnitRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead: type: string format: uri description: 'Lead being shared. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity being shared. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' unit: type: string format: uri description: 'Sales unit the lead or opportunity is shared with. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''SalesUnit'' object for properties.' lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - unit - lead_oppty_id - unit_id batchLeadOpptyStepCheckListRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'Document linked as evidence for this checklist item. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' note: type: object properties: id: type: string format: uri description: 'Note linked as evidence for this checklist item. Relation to Note, see: ''updateNoteInput'' object for properties.' activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the appointment or task linked as evidence for this checklist item. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. item_checked: type: boolean example: false description: True when the checklist item has been completed for this lead, opportunity or quote. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity, or empty when this completion belongs to a quote. note_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the note. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. step_checklist_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the step checklist item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid LeadOpptyContactGroupRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true lead: type: string format: uri description: 'Lead this contact group belongs to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity this contact group belongs to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' color: type: integer format: int32 example: 1 description: 'Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' group_position: type: object description: 'Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }.' lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the contact group belongs to. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - color - group_position - lead_oppty_id - name createOpptyProductRelationRevenueScheduleInput: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with OpptyProductRelation id. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the line-item amount is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for this product line begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - id batchLeadOpptyKPIInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove. Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove' example: 1 enum: - 1 - 2 - 4 - 5 - 6 - 7 - 8 lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the KPI event relates to. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createOpptyProductRelationTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. is_readonly: type: boolean example: false description: True when the line-item type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_readonly - name updateLeadOpptyContactRelationInput: properties: lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Relation to LeadOpptyContactGroupRelation, see: ''updateLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-form note describing this contact link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. position_in_group: type: object description: 'Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }.' relationship: type: integer description: 'Org-chart relationship of the contact within the lead/opportunity hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong' example: 0 enum: - 0 - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sales_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactSalesRoleRelation, see: ''updateLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the contact for this lead or opportunity. updateOpptyProductRelationRevenueSchedulePeriodInput: properties: oppty_product_relation_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyProductRelationRevenueSchedule, see: ''updateOpptyProductRelationRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_product_relation_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchLeadOpptyContactRelationInput: properties: lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Relation to LeadOpptyContactGroupRelation, see: ''updateLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-form note describing this contact link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. position_in_group: type: object description: 'Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }.' relationship: type: integer description: 'Org-chart relationship of the contact within the lead/opportunity hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong' example: 0 enum: - 0 - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sales_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactSalesRoleRelation, see: ''updateLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the contact for this lead or opportunity. id: description: ID of object to update. type: string format: uuid LeadOpptyStepCheckListRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true appointment: type: string format: uri description: 'Appointment used as evidence for this checklist item. Set when activity_id resolves to an Appointment; otherwise empty. Relation to Appointment. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Appointment'' object for properties.' task: type: string format: uri description: 'Task used as evidence for this checklist item. Set when activity_id resolves to a Task; otherwise empty. Relation to Task. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Task'' object for properties.' cloud_object: type: string format: uri description: 'Document linked as evidence for this checklist item. 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.' email: type: string format: uri description: 'Email linked as evidence for this checklist item. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' lead: type: string format: uri description: 'Lead this checklist completion belongs to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity this checklist completion belongs to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' note: type: string format: uri description: 'Note linked as evidence for this checklist item. 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.' quote: type: string format: uri description: 'Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. 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.' step_checklist: type: string format: uri description: 'Step checklist item this completion record refers to. 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.' activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the appointment or task linked as evidence for this checklist item. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. item_checked: type: boolean example: false description: True when the checklist item has been completed for this lead, opportunity or quote. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity, or empty when this completion belongs to a quote. note_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the note. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. step_checklist_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the step checklist item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - step_checklist - step_checklist_id batchOpptyProductRelationRevenueScheduleInput: properties: is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the line-item amount is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for this product line begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid OpptyProductRelationRevenueSchedule: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with OpptyProductRelation id. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the line-item amount is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for this product line begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. periods: type: array items: type: string format: uri description: 'Relation to OpptyProductRelationRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OpptyProductRelationRevenueSchedulePeriod'' object for properties.' description: Periods produced by this revenue schedule, ordered by date. required: - is_delete_protected - id batchLeadOpptySharingSalesUnitRelationInput: properties: lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid OpptyRevenueSchedule: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with Opportunity id. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the opportunity value is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for the opportunity begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. periods: type: array items: type: string format: uri description: 'Relation to OpptyRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OpptyRevenueSchedulePeriod'' object for properties.' description: Periods produced by this revenue schedule, ordered by date. required: - is_delete_protected - id LeadOpptyDataExRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true data: type: string format: uri description: 'Data record holding the additional fields linked to this lead or opportunity. 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.' lead: type: string format: uri description: 'Lead this data relation row applies to, when the row is associated with a lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity this data relation row applies to, when the row is associated with an opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the linked fields belong to. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the data relation row applies to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - data - data_id - data_set_id - lead_oppty_id OpportunityType: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true pipeline: type: string format: uri description: 'Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline. 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.' form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing opportunities of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields. form_qualify: type: object description: JSON definition of the form shown when qualifying a lead into an opportunity of this type. form_won: type: object description: JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields. is_readonly: type: boolean example: false description: True when the opportunity type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. pipeline_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. form_lost_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. form_qualify_api: type: array items: type: object description: List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts. form_won_api: type: array items: type: object description: List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts. required: - id - pipeline - is_readonly - name - pipeline_id - settings - has_draft - is_delete_protected - form_edit_api - form_lost_api - form_qualify_api - form_won_api updateLeadOpptySharingSalesUnitRelationInput: properties: lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createOpptyRevenueScheduleInput: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with Opportunity id. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cancelation_date: type: string format: date example: '2019-01-01' description: Date when the revenue schedule was cancelled. Empty for active schedules. period_count: type: integer format: int32 example: 1 description: Number of periods the opportunity value is split into. period_type: type: integer description: 'Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year' example: 1 enum: - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01' description: Date when revenue recognition for the opportunity begins. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - id updateLeadOpptySharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity being shared. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. OpptyRevenueSchedulePeriod: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty_revenue_schedule: type: string format: uri description: 'Parent revenue schedule this period belongs to. 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.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - oppty_revenue_schedule - oppty_revenue_schedule_id - transaction_id batchOpportunityInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. active_quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the active quote. closing_date: type: string format: date example: '2019-01-01' description: Expected or actual closing date of the opportunity. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this opportunity. description: type: string example: string description: Free-form description of the opportunity. is_archived: type: boolean example: false description: True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. is_value_auto_calculate: type: boolean example: false description: True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the opportunity in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this opportunity. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity type. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at opportunity creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at opportunity creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at opportunity creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at opportunity creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at opportunity creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. reason_of_close_description: type: string example: string description: Free-form note explaining why the opportunity was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. was_qualified: type: boolean example: false description: True when the opportunity has gone through the qualification step at least once. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. value: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. oppty_recurrence: type: object properties: id: type: string format: uri description: 'Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. Relation to OpptyRecurrence, see: ''updateOpptyRecurrenceInput'' object for properties.' revenue_schedule: type: object properties: id: type: string format: uri description: 'Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. Relation to OpptyRevenueSchedule, see: ''updateOpptyRevenueScheduleInput'' object for properties.' product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' description: Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this opportunity, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''updateLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this opportunity, including the primary-account flag. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this opportunity. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to Quote, see: ''updateQuoteInput'' object for properties.' description: Quotes prepared for this opportunity. won_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''updateLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''updateLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this opportunity. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this opportunity currently matches. id: description: ID of object to update. type: string format: uuid updateLeadOpptyContactGroupRelationInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' group_position: type: object description: 'Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }.' lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity the contact group belongs to. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createOpptyProductRelationRevenueSchedulePeriodInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty_product_relation_revenue_schedule: type: object properties: id: type: string format: uri description: 'Parent revenue schedule this period belongs to. Relation to OpptyProductRelationRevenueSchedule, see: ''createOpptyProductRelationRevenueScheduleInput'' object for properties.' date: type: string format: date example: '2019-01-01' description: Recognition date of this period. oppty_product_relation_revenue_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent revenue schedule. transaction_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier linking the period to the recognition transaction. value: type: number format: double example: 4.32 description: Amount recognised in this period. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - oppty_product_relation_revenue_schedule - oppty_product_relation_revenue_schedule_id - transaction_id batchLeadOpptyAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead or opportunity this link belongs to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createLeadTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing leads of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving leads of this type. is_readonly: type: boolean example: false description: True when the lead type is system-managed and cannot be edited or deleted by users. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - form_lost_enabled - is_readonly - lead_process_id - name - settings batchOpptyProductRelationTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. is_readonly: type: boolean example: false description: True when the line-item type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateOpportunityInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. active_quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the active quote. closing_date: type: string format: date example: '2019-01-01' description: Expected or actual closing date of the opportunity. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this opportunity. description: type: string example: string description: Free-form description of the opportunity. is_archived: type: boolean example: false description: True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. is_value_auto_calculate: type: boolean example: false description: True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the opportunity in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this opportunity. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity type. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at opportunity creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at opportunity creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at opportunity creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at opportunity creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at opportunity creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. reason_of_close_description: type: string example: string description: Free-form note explaining why the opportunity was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. was_qualified: type: boolean example: false description: True when the opportunity has gone through the qualification step at least once. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. value: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. oppty_recurrence: type: object properties: id: type: string format: uri description: 'Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. Relation to OpptyRecurrence, see: ''updateOpptyRecurrenceInput'' object for properties.' revenue_schedule: type: object properties: id: type: string format: uri description: 'Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. Relation to OpptyRevenueSchedule, see: ''updateOpptyRevenueScheduleInput'' object for properties.' product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' description: Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this opportunity, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''updateLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this opportunity, including the primary-account flag. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this opportunity. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to Quote, see: ''updateQuoteInput'' object for properties.' description: Quotes prepared for this opportunity. won_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''updateLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''updateLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this opportunity. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this opportunity currently matches. createOpptyProductRelationDataExRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true oppty_product_relation: type: object properties: id: type: string format: uri description: 'Product line item this enrichment record applies to. Relation to OpptyProductRelation, see: ''createOpptyProductRelationInput'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the external data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the enrichment record originates from. oppty_product_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product line item. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - oppty_product_relation - data_id - data_set_id - oppty_product_relation_id batchLeadOpptyContactSalesRoleRelationInput: properties: lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Lead/opportunity-contact link this sales-role assignment belongs to. Relation to LeadOpptyContactRelation, see: ''updateLeadOpptyContactRelationInput'' object for properties.' lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead/opportunity-contact link. sales_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales role. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid Opportunity: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. active_quote: type: string format: uri description: 'Quote currently used to drive the opportunity (e.g. for synchronisation of monetary fields). Empty when no quote is active. 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.' currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this opportunity. Empty to inherit the team space default. 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.' lead_source: type: string format: uri description: 'How the opportunity originated (e.g. Website, Referral, Trade Show). Configurable per team space. 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.' oppty_type: type: string format: uri description: 'Opportunity type that classifies this opportunity. Each type maps to one pipeline and drives which form, fields and stages apply. 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.' owner: type: string format: uri description: 'Sales user who owns this opportunity. 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.' product_currency: type: string format: uri description: 'Currency used for product line-item prices on this opportunity. Relation to Currency. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Currency'' object for properties.' product_price_list: type: string format: uri description: 'Product price list used to populate prices for product line items added to this opportunity. Empty to use catalog defaults. 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.' reason_of_close: type: string format: uri description: 'Configurable reason recorded when the opportunity is archived (lost). Required when the lost form mandates it. 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.' step: type: string format: uri description: 'Pipeline step the opportunity is currently sitting in. Reaching the last step in the pipeline marks the opportunity as won; archiving sets it to lost. 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.' unit: type: string format: uri description: 'Sales unit this opportunity is assigned to. Determines which team members can see the record under unit-based sharing. 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.' active_quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the active quote. closing_date: type: string format: date example: '2019-01-01' description: Expected or actual closing date of the opportunity. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this opportunity. description: type: string example: string description: Free-form description of the opportunity. is_archived: type: boolean example: false description: True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. is_value_auto_calculate: type: boolean example: false description: True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the opportunity in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this opportunity. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity type. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at opportunity creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at opportunity creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at opportunity creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at opportunity creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at opportunity creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. reason_of_close_description: type: string example: string description: Free-form note explaining why the opportunity was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. table_name: type: string example: string description: Discriminator identifying the concrete record type — always "opportunity" for Opportunity records. Read-only; useful when consuming polymorphic LeadOppty results. readOnly: true unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. was_qualified: type: boolean example: false description: True when the opportunity has gone through the qualification step at least once. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. value: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. oppty_recurrence: type: string format: uri description: 'Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. 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.' revenue_schedule: type: string format: uri description: 'Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. 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.' product_relations: type: array items: type: string format: uri description: 'Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OpptyProductRelation'' object for properties.' description: Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true. primary_contact: type: string format: uri description: 'Primary contact of this opportunity. Set automatically from the contact relation marked as primary. 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.' primary_account: type: string format: uri description: 'Primary account of this opportunity. Set automatically from the account relation marked as primary. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' contact_relations: type: array items: type: string format: uri description: 'Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptyContactRelation'' object for properties.' description: Contacts linked to this opportunity, including their roles and org-chart positions. account_relations: type: array items: type: string format: uri description: 'Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptyAccountRelation'' object for properties.' description: Accounts linked to this opportunity, including the primary-account flag. documents: type: array items: type: string format: uri description: 'Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObjectRelation'' object for properties.' description: Documents linked to this opportunity. quote_relations: type: array items: type: string format: uri description: 'Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' description: Quotes prepared for this opportunity. status: type: integer description: 'Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. Integer enum value: 1 - Open, 2 - Lost, 3 - Won' example: 1 enum: - 1 - 2 - 3 readOnly: true qualify_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was qualified, taken from the matching KPI event. Empty for opportunities that have not been qualified. Read-only. won_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. days_in_step: type: integer format: int32 example: 1 description: Number of days the opportunity has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event and per-step timeframe history. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this opportunity as favorite. Per-user. sharing_units: type: array items: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptySharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadOpptySharingClientRelation'' object for properties.' description: Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing. tags: type: array items: type: string format: uri description: 'Relation to TagRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''TagRelation'' object for properties.' description: Tag labels applied to this opportunity. static_profiles: type: array items: type: string format: uri description: 'Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProfileRelation'' object for properties.' description: Saved view profiles this opportunity currently matches. formatted_name: type: string example: string description: Display version of the opportunity name, used in lists and references. modified_by_user: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. required: - is_delete_protected - id - oppty_type - owner - product_currency - step - unit - closing_date - name - owner_id - step_id - table_name - value - status - days_in_step - is_favorite - formatted_name batchStepInput: properties: description: type: string example: string description: Free-text description shown in the step UI. has_readonly_form: type: boolean example: false description: When true, the record form is read-only while a record is in this step. has_version_increment: type: boolean example: false description: When true, transitioning a record into this step bumps its version counter. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. percent: type: integer format: int32 example: 1 description: Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. sort_order: type: integer format: int32 example: 1 description: Position of the step within its pipeline or process; lower values appear first. timeframe: type: integer format: int32 example: 1 description: Expected number of days a record should spend in this step. Used to flag overdue records. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectStepRelation, see: ''updateCloudObjectStepRelationInput'' object for properties.' description: Files attached to the step (e.g. step-specific documentation or templates). step_checklists: type: array items: type: object properties: id: type: string format: uri description: 'Relation to StepChecklist, see: ''updateStepChecklistInput'' object for properties.' description: Checklist items the user must complete before moving a record out of this step. id: description: ID of object to update. type: string format: uuid createOpportunityInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. active_quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the active quote. closing_date: type: string format: date example: '2019-01-01' description: Expected or actual closing date of the opportunity. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this opportunity. description: type: string example: string description: Free-form description of the opportunity. is_archived: type: boolean example: false description: True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. is_value_auto_calculate: type: boolean example: false description: True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: User-set colored flag used to highlight the opportunity in lists and reports. last_ai_buying_center_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested buying center was last applied to this opportunity. lead_source_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead source. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity type. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at opportunity creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at opportunity creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at opportunity creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at opportunity creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at opportunity creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. ranking: type: integer format: int32 example: 1 description: Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. reason_of_close_description: type: string example: string description: Free-form note explaining why the opportunity was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. was_qualified: type: boolean example: false description: True when the opportunity has gone through the qualification step at least once. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. value: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. oppty_recurrence: type: object properties: id: type: string format: uri description: 'Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. Relation to OpptyRecurrence, see: ''createOpptyRecurrenceInput'' object for properties.' revenue_schedule: type: object properties: id: type: string format: uri description: 'Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. Relation to OpptyRevenueSchedule, see: ''createOpptyRevenueScheduleInput'' object for properties.' product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''createOpptyProductRelationInput'' object for properties.' description: Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyContactRelation, see: ''createLeadOpptyContactRelationInput'' object for properties.' description: Contacts linked to this opportunity, including their roles and org-chart positions. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptyAccountRelation, see: ''createLeadOpptyAccountRelationInput'' object for properties.' description: Accounts linked to this opportunity, including the primary-account flag. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Documents linked to this opportunity. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to Quote, see: ''createQuoteInput'' object for properties.' description: Quotes prepared for this opportunity. won_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. lost_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingSalesUnitRelation, see: ''createLeadOpptySharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to LeadOpptySharingClientRelation, see: ''createLeadOpptySharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''createTagRelationInput'' object for properties.' description: Tag labels applied to this opportunity. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''createProfileRelationInput'' object for properties.' description: Saved view profiles this opportunity currently matches. required: - closing_date - name - owner_id - step_id - value