openapi: 3.2.0 info: title: Pipeliner Cloud Contact 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: Contact paths: /entities/Contacts/{id}: get: description: Returns Contact with given id operationId: Contacts.get summary: Contacts.get tags: - Contact parameters: - name: id in: path description: ID of Contact to retrieve required: true schema: type: string format: uuid responses: '200': description: Contact 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/Contact' '404': description: Sent when 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 Contact with given id operationId: Contacts.delete summary: Contacts.delete tags: - Contact parameters: - name: id in: path description: ID of Contact to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Contact on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 Contact 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 Contact or Contacts with given id(s) parameters: - name: id in: path description: ID of Contact to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Contact on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: Contacts.update summary: Contacts.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactInput' responses: '200': description: Modification confirmation. Returns resulting Contact content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Contact' '404': description: Sent when 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/Contacts: get: description: Returns all defined Contacts operationId: Contacts.list summary: Contacts.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted Contacts 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 Contacts 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/Contact' 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 Contact operationId: Contacts.create summary: Contacts.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of Contact on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new Contact required: true content: application / json: schema: $ref: '#/components/schemas/createContactInput' responses: '201': description: Creation confirmation. Returns created Contact content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Contact' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Contacts/merge: post: description: Merger multiple Contacts into master record. operationId: Contacts.merge summary: Contacts.merge tags: - Contact parameters: [] requestBody: description: Entity . required: true content: application/json: schema: type: object properties: master: $ref: '#/components/schemas/batchContactInput' secondary_ids: type: array items: type: string description: An id of secondary Contact. format: uuid responses: '200': description: Merged entity content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Contact' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Contacts/batch-delete: post: description: Removes Contacts with given list of ids operationId: Contacts.batch_delete summary: Contacts.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of Contacts on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Contacts. 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 Contact 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 Contact. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Contacts/batch-modify: post: description: Create or update an batch of Contacts operationId: Contacts.batch_create_or_update summary: Contacts.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of Contacts on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Contact required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Contacts 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/Contacts/batch-restore: post: description: Restores Contacts with given list of ids operationId: Contacts.batch_restore summary: Contacts.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of Contacts 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 Contacts. 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 Contact 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 Contact. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountAccountRoleRelations/{id}: get: description: Returns ContactAccountAccountRoleRelation with given id operationId: ContactAccountAccountRoleRelations.get summary: ContactAccountAccountRoleRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactAccountAccountRoleRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactAccountAccountRoleRelation 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/ContactAccountAccountRoleRelation' '404': description: Sent when 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 ContactAccountAccountRoleRelation with given id operationId: ContactAccountAccountRoleRelations.delete summary: ContactAccountAccountRoleRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactAccountAccountRoleRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactAccountAccountRoleRelation 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 ContactAccountAccountRoleRelation or ContactAccountAccountRoleRelations with given id(s) parameters: - name: id in: path description: ID of ContactAccountAccountRoleRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactAccountAccountRoleRelations.update summary: ContactAccountAccountRoleRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactAccountAccountRoleRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactAccountAccountRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' '404': description: Sent when 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/ContactAccountAccountRoleRelations: get: description: Returns all defined ContactAccountAccountRoleRelations operationId: ContactAccountAccountRoleRelations.list summary: ContactAccountAccountRoleRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactAccountAccountRoleRelations 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 ContactAccountAccountRoleRelations 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/ContactAccountAccountRoleRelation' 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 ContactAccountAccountRoleRelation operationId: ContactAccountAccountRoleRelations.create summary: ContactAccountAccountRoleRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactAccountAccountRoleRelationInput' responses: '201': description: Creation confirmation. Returns created ContactAccountAccountRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactAccountAccountRoleRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountAccountRoleRelations/batch-delete: post: description: Removes ContactAccountAccountRoleRelations with given list of ids operationId: ContactAccountAccountRoleRelations.batch_delete summary: ContactAccountAccountRoleRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactAccountAccountRoleRelations. 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 ContactAccountAccountRoleRelation 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 ContactAccountAccountRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountAccountRoleRelations/batch-modify: post: description: Create or update an batch of ContactAccountAccountRoleRelations operationId: ContactAccountAccountRoleRelations.batch_create_or_update summary: ContactAccountAccountRoleRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactAccountAccountRoleRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactAccountAccountRoleRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactAccountAccountRoleRelations 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/ContactAccountAccountRoleRelations/batch-restore: post: description: Restores ContactAccountAccountRoleRelations with given list of ids operationId: ContactAccountAccountRoleRelations.batch_restore summary: ContactAccountAccountRoleRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountAccountRoleRelations 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 ContactAccountAccountRoleRelations. 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 ContactAccountAccountRoleRelation 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 ContactAccountAccountRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountRelations/{id}: get: description: Returns ContactAccountRelation with given id operationId: ContactAccountRelations.get summary: ContactAccountRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactAccountRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactAccountRelation 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/ContactAccountRelation' '404': description: Sent when 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 ContactAccountRelation with given id operationId: ContactAccountRelations.delete summary: ContactAccountRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactAccountRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactAccountRelation 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 ContactAccountRelation or ContactAccountRelations with given id(s) parameters: - name: id in: path description: ID of ContactAccountRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactAccountRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactAccountRelations.update summary: ContactAccountRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactAccountRelation' '404': description: Sent when 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/ContactAccountRelations: get: description: Returns all defined ContactAccountRelations operationId: ContactAccountRelations.list summary: ContactAccountRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactAccountRelations 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 ContactAccountRelations 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/ContactAccountRelation' 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 ContactAccountRelation operationId: ContactAccountRelations.create summary: ContactAccountRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactAccountRelationInput' responses: '201': description: Creation confirmation. Returns created ContactAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactAccountRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountRelations/batch-delete: post: description: Removes ContactAccountRelations with given list of ids operationId: ContactAccountRelations.batch_delete summary: ContactAccountRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactAccountRelations. 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 ContactAccountRelation 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 ContactAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactAccountRelations/batch-modify: post: description: Create or update an batch of ContactAccountRelations operationId: ContactAccountRelations.batch_create_or_update summary: ContactAccountRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactAccountRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactAccountRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactAccountRelations 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/ContactAccountRelations/batch-restore: post: description: Restores ContactAccountRelations with given list of ids operationId: ContactAccountRelations.batch_restore summary: ContactAccountRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactAccountRelations 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 ContactAccountRelations. 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 ContactAccountRelation 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 ContactAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactDataExRelations/{id}: get: description: Returns ContactDataExRelation with given id operationId: ContactDataExRelations.get summary: ContactDataExRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactDataExRelation 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/ContactDataExRelation' '404': description: Sent when 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/ContactDataExRelations: get: description: Returns all defined ContactDataExRelations operationId: ContactDataExRelations.list summary: ContactDataExRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactDataExRelations 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 ContactDataExRelations 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/ContactDataExRelation' 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/ContactKPIs/{id}: get: description: Returns ContactKPI with given id operationId: ContactKPIs.get summary: ContactKPIs.get tags: - Contact parameters: - name: id in: path description: ID of ContactKPI to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactKPI 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/ContactKPI' '404': description: Sent when 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 ContactKPI with given id operationId: ContactKPIs.delete summary: ContactKPIs.delete tags: - Contact parameters: - name: id in: path description: ID of ContactKPI to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactKPI on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactKPI 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 ContactKPI or ContactKPIs with given id(s) parameters: - name: id in: path description: ID of ContactKPI to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactKPI on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactKPIs.update summary: ContactKPIs.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactKPIInput' responses: '200': description: Modification confirmation. Returns resulting ContactKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactKPI' '404': description: Sent when 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/ContactKPIs: get: description: Returns all defined ContactKPIs operationId: ContactKPIs.list summary: ContactKPIs.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactKPIs 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 ContactKPIs 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/ContactKPI' 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 ContactKPI operationId: ContactKPIs.create summary: ContactKPIs.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactKPI on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactKPI required: true content: application / json: schema: $ref: '#/components/schemas/createContactKPIInput' responses: '201': description: Creation confirmation. Returns created ContactKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactKPI' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactKPIs/batch-delete: post: description: Removes ContactKPIs with given list of ids operationId: ContactKPIs.batch_delete summary: ContactKPIs.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactKPIs on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactKPIs. 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 ContactKPI 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 ContactKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactKPIs/batch-modify: post: description: Create or update an batch of ContactKPIs operationId: ContactKPIs.batch_create_or_update summary: ContactKPIs.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactKPIs on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactKPI required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactKPIInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactKPIs 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/ContactKPIs/batch-restore: post: description: Restores ContactKPIs with given list of ids operationId: ContactKPIs.batch_restore summary: ContactKPIs.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactKPIs 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 ContactKPIs. 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 ContactKPI 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 ContactKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelations/{id}: get: description: Returns ContactRelation with given id operationId: ContactRelations.get summary: ContactRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactRelation 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/ContactRelation' '404': description: Sent when 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 ContactRelation with given id operationId: ContactRelations.delete summary: ContactRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactRelation 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 ContactRelation or ContactRelations with given id(s) parameters: - name: id in: path description: ID of ContactRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactRelations.update summary: ContactRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelation' '404': description: Sent when 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/ContactRelations: get: description: Returns all defined ContactRelations operationId: ContactRelations.list summary: ContactRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactRelations 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 ContactRelations 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/ContactRelation' 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 ContactRelation operationId: ContactRelations.create summary: ContactRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationInput' responses: '201': description: Creation confirmation. Returns created ContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelations/batch-delete: post: description: Removes ContactRelations with given list of ids operationId: ContactRelations.batch_delete summary: ContactRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelations. 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 ContactRelation 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 ContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelations/batch-modify: post: description: Create or update an batch of ContactRelations operationId: ContactRelations.batch_create_or_update summary: ContactRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactRelations 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/ContactRelations/batch-restore: post: description: Restores ContactRelations with given list of ids operationId: ContactRelations.batch_restore summary: ContactRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelations 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 ContactRelations. 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 ContactRelation 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 ContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationLabels/{id}: get: description: Returns ContactRelationLabel with given id operationId: ContactRelationLabels.get summary: ContactRelationLabels.get tags: - Contact parameters: - name: id in: path description: ID of ContactRelationLabel to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactRelationLabel 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/ContactRelationLabel' '404': description: Sent when 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 ContactRelationLabel with given id operationId: ContactRelationLabels.delete summary: ContactRelationLabels.delete tags: - Contact parameters: - name: id in: path description: ID of ContactRelationLabel to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelationLabel on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactRelationLabel 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 ContactRelationLabel or ContactRelationLabels with given id(s) parameters: - name: id in: path description: ID of ContactRelationLabel to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelationLabel on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactRelationLabels.update summary: ContactRelationLabels.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationLabelInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelationLabel content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelationLabel' '404': description: Sent when 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/ContactRelationLabels: get: description: Returns all defined ContactRelationLabels operationId: ContactRelationLabels.list summary: ContactRelationLabels.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactRelationLabels 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 ContactRelationLabels 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/ContactRelationLabel' 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 ContactRelationLabel operationId: ContactRelationLabels.create summary: ContactRelationLabels.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationLabel on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationLabelInput' responses: '201': description: Creation confirmation. Returns created ContactRelationLabel content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelationLabel' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationLabels/batch-delete: post: description: Removes ContactRelationLabels with given list of ids operationId: ContactRelationLabels.batch_delete summary: ContactRelationLabels.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationLabels on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelationLabels. 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 ContactRelationLabel 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 ContactRelationLabel. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationLabels/batch-modify: post: description: Create or update an batch of ContactRelationLabels operationId: ContactRelationLabels.batch_create_or_update summary: ContactRelationLabels.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationLabels on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactRelationLabel required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactRelationLabelInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactRelationLabels 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/ContactRelationLabels/batch-restore: post: description: Restores ContactRelationLabels with given list of ids operationId: ContactRelationLabels.batch_restore summary: ContactRelationLabels.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationLabels 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 ContactRelationLabels. 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 ContactRelationLabel 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 ContactRelationLabel. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationTypes/{id}: get: description: Returns ContactRelationType with given id operationId: ContactRelationTypes.get summary: ContactRelationTypes.get tags: - Contact parameters: - name: id in: path description: ID of ContactRelationType to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactRelationType 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/ContactRelationType' '404': description: Sent when 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 ContactRelationType with given id operationId: ContactRelationTypes.delete summary: ContactRelationTypes.delete tags: - Contact parameters: - name: id in: path description: ID of ContactRelationType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelationType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactRelationType 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 ContactRelationType or ContactRelationTypes with given id(s) parameters: - name: id in: path description: ID of ContactRelationType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactRelationType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactRelationTypes.update summary: ContactRelationTypes.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting ContactRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelationType' '404': description: Sent when 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/ContactRelationTypes: get: description: Returns all defined ContactRelationTypes operationId: ContactRelationTypes.list summary: ContactRelationTypes.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactRelationTypes 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 ContactRelationTypes 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/ContactRelationType' 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 ContactRelationType operationId: ContactRelationTypes.create summary: ContactRelationTypes.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createContactRelationTypeInput' responses: '201': description: Creation confirmation. Returns created ContactRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactRelationType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationTypes/batch-delete: post: description: Removes ContactRelationTypes with given list of ids operationId: ContactRelationTypes.batch_delete summary: ContactRelationTypes.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelationTypes. 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 ContactRelationType 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 ContactRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactRelationTypes/batch-modify: post: description: Create or update an batch of ContactRelationTypes operationId: ContactRelationTypes.batch_create_or_update summary: ContactRelationTypes.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactRelationType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactRelationTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactRelationTypes 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/ContactRelationTypes/batch-restore: post: description: Restores ContactRelationTypes with given list of ids operationId: ContactRelationTypes.batch_restore summary: ContactRelationTypes.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactRelationTypes 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 ContactRelationTypes. 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 ContactRelationType 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 ContactRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingClientRelations/{id}: get: description: Returns ContactSharingClientRelation with given id operationId: ContactSharingClientRelations.get summary: ContactSharingClientRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactSharingClientRelation 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/ContactSharingClientRelation' '404': description: Sent when 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 ContactSharingClientRelation with given id operationId: ContactSharingClientRelations.delete summary: ContactSharingClientRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactSharingClientRelation 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 ContactSharingClientRelation or ContactSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of ContactSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactSharingClientRelations.update summary: ContactSharingClientRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSharingClientRelation' '404': description: Sent when 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/ContactSharingClientRelations: get: description: Returns all defined ContactSharingClientRelations operationId: ContactSharingClientRelations.list summary: ContactSharingClientRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactSharingClientRelations 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 ContactSharingClientRelations 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/ContactSharingClientRelation' 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 ContactSharingClientRelation operationId: ContactSharingClientRelations.create summary: ContactSharingClientRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created ContactSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingClientRelations/batch-delete: post: description: Removes ContactSharingClientRelations with given list of ids operationId: ContactSharingClientRelations.batch_delete summary: ContactSharingClientRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSharingClientRelations. 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 ContactSharingClientRelation 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 ContactSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingClientRelations/batch-modify: post: description: Create or update an batch of ContactSharingClientRelations operationId: ContactSharingClientRelations.batch_create_or_update summary: ContactSharingClientRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactSharingClientRelations 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/ContactSharingClientRelations/batch-restore: post: description: Restores ContactSharingClientRelations with given list of ids operationId: ContactSharingClientRelations.batch_restore summary: ContactSharingClientRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingClientRelations 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 ContactSharingClientRelations. 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 ContactSharingClientRelation 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 ContactSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingSalesUnitRelations/{id}: get: description: Returns ContactSharingSalesUnitRelation with given id operationId: ContactSharingSalesUnitRelations.get summary: ContactSharingSalesUnitRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactSharingSalesUnitRelation 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/ContactSharingSalesUnitRelation' '404': description: Sent when 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 ContactSharingSalesUnitRelation with given id operationId: ContactSharingSalesUnitRelations.delete summary: ContactSharingSalesUnitRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactSharingSalesUnitRelation 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 ContactSharingSalesUnitRelation or ContactSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of ContactSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactSharingSalesUnitRelations.update summary: ContactSharingSalesUnitRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' '404': description: Sent when 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/ContactSharingSalesUnitRelations: get: description: Returns all defined ContactSharingSalesUnitRelations operationId: ContactSharingSalesUnitRelations.list summary: ContactSharingSalesUnitRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactSharingSalesUnitRelations 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 ContactSharingSalesUnitRelations 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/ContactSharingSalesUnitRelation' 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 ContactSharingSalesUnitRelation operationId: ContactSharingSalesUnitRelations.create summary: ContactSharingSalesUnitRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created ContactSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingSalesUnitRelations/batch-delete: post: description: Removes ContactSharingSalesUnitRelations with given list of ids operationId: ContactSharingSalesUnitRelations.batch_delete summary: ContactSharingSalesUnitRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSharingSalesUnitRelations. 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 ContactSharingSalesUnitRelation 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 ContactSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of ContactSharingSalesUnitRelations operationId: ContactSharingSalesUnitRelations.batch_create_or_update summary: ContactSharingSalesUnitRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactSharingSalesUnitRelations 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/ContactSharingSalesUnitRelations/batch-restore: post: description: Restores ContactSharingSalesUnitRelations with given list of ids operationId: ContactSharingSalesUnitRelations.batch_restore summary: ContactSharingSalesUnitRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSharingSalesUnitRelations 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 ContactSharingSalesUnitRelations. 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 ContactSharingSalesUnitRelation 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 ContactSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSocialRelations/{id}: get: description: Returns ContactSocialRelation with given id operationId: ContactSocialRelations.get summary: ContactSocialRelations.get tags: - Contact parameters: - name: id in: path description: ID of ContactSocialRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactSocialRelation 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/ContactSocialRelation' '404': description: Sent when 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 ContactSocialRelation with given id operationId: ContactSocialRelations.delete summary: ContactSocialRelations.delete tags: - Contact parameters: - name: id in: path description: ID of ContactSocialRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSocialRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactSocialRelation 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 ContactSocialRelation or ContactSocialRelations with given id(s) parameters: - name: id in: path description: ID of ContactSocialRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactSocialRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactSocialRelations.update summary: ContactSocialRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactSocialRelationInput' responses: '200': description: Modification confirmation. Returns resulting ContactSocialRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSocialRelation' '404': description: Sent when 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/ContactSocialRelations: get: description: Returns all defined ContactSocialRelations operationId: ContactSocialRelations.list summary: ContactSocialRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactSocialRelations 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 ContactSocialRelations 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/ContactSocialRelation' 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 ContactSocialRelation operationId: ContactSocialRelations.create summary: ContactSocialRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSocialRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/createContactSocialRelationInput' responses: '201': description: Creation confirmation. Returns created ContactSocialRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactSocialRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSocialRelations/batch-delete: post: description: Removes ContactSocialRelations with given list of ids operationId: ContactSocialRelations.batch_delete summary: ContactSocialRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSocialRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSocialRelations. 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 ContactSocialRelation 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 ContactSocialRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactSocialRelations/batch-modify: post: description: Create or update an batch of ContactSocialRelations operationId: ContactSocialRelations.batch_create_or_update summary: ContactSocialRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSocialRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactSocialRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactSocialRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactSocialRelations 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/ContactSocialRelations/batch-restore: post: description: Restores ContactSocialRelations with given list of ids operationId: ContactSocialRelations.batch_restore summary: ContactSocialRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactSocialRelations 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 ContactSocialRelations. 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 ContactSocialRelation 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 ContactSocialRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactTypes/{id}: get: description: Returns ContactType with given id operationId: ContactTypes.get summary: ContactTypes.get tags: - Contact parameters: - name: id in: path description: ID of ContactType to retrieve required: true schema: type: string format: uuid responses: '200': description: ContactType 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/ContactType' '404': description: Sent when 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 ContactType with given id operationId: ContactTypes.delete summary: ContactTypes.delete tags: - Contact parameters: - name: id in: path description: ID of ContactType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 ContactType 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 ContactType or ContactTypes with given id(s) parameters: - name: id in: path description: ID of ContactType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ContactType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ContactTypes.update summary: ContactTypes.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateContactTypeInput' responses: '200': description: Modification confirmation. Returns resulting ContactType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactType' '404': description: Sent when 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/ContactTypes: get: description: Returns all defined ContactTypes operationId: ContactTypes.list summary: ContactTypes.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted ContactTypes 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 ContactTypes 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/ContactType' 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 ContactType operationId: ContactTypes.create summary: ContactTypes.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ContactType required: true content: application / json: schema: $ref: '#/components/schemas/createContactTypeInput' responses: '201': description: Creation confirmation. Returns created ContactType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ContactType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactTypes/batch-delete: post: description: Removes ContactTypes with given list of ids operationId: ContactTypes.batch_delete summary: ContactTypes.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactTypes. 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 ContactType 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 ContactType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ContactTypes/batch-modify: post: description: Create or update an batch of ContactTypes operationId: ContactTypes.batch_create_or_update summary: ContactTypes.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ContactType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchContactTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ContactTypes 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/ContactTypes/batch-restore: post: description: Restores ContactTypes with given list of ids operationId: ContactTypes.batch_restore summary: ContactTypes.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of ContactTypes 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 ContactTypes. 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 ContactType 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 ContactType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContacts/{id}: get: description: Returns GhostContact with given id operationId: GhostContacts.get summary: GhostContacts.get tags: - Contact parameters: - name: id in: path description: ID of GhostContact to retrieve required: true schema: type: string format: uuid responses: '200': description: GhostContact 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/GhostContact' '404': description: Sent when 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 GhostContact with given id operationId: GhostContacts.delete summary: GhostContacts.delete tags: - Contact parameters: - name: id in: path description: ID of GhostContact to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContact on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 GhostContact 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 GhostContact or GhostContacts with given id(s) parameters: - name: id in: path description: ID of GhostContact to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContact on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: GhostContacts.update summary: GhostContacts.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostContactInput' responses: '200': description: Modification confirmation. Returns resulting GhostContact content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContact' '404': description: Sent when 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/GhostContacts: get: description: Returns all defined GhostContacts operationId: GhostContacts.list summary: GhostContacts.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted GhostContacts 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 GhostContacts 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/GhostContact' 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 GhostContact operationId: GhostContacts.create summary: GhostContacts.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContact on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new GhostContact required: true content: application / json: schema: $ref: '#/components/schemas/createGhostContactInput' responses: '201': description: Creation confirmation. Returns created GhostContact content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContact' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContacts/batch-delete: post: description: Removes GhostContacts with given list of ids operationId: GhostContacts.batch_delete summary: GhostContacts.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContacts on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContacts. 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 GhostContact 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 GhostContact. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContacts/batch-modify: post: description: Create or update an batch of GhostContacts operationId: GhostContacts.batch_create_or_update summary: GhostContacts.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContacts on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new GhostContact required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchGhostContactInput' responses: '200': description: Creation confirmation. Returns a list of created / updated GhostContacts 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/GhostContacts/batch-restore: post: description: Restores GhostContacts with given list of ids operationId: GhostContacts.batch_restore summary: GhostContacts.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContacts 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 GhostContacts. 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 GhostContact 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 GhostContact. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountAccountRoleRelations/{id}: get: description: Returns GhostContactAccountAccountRoleRelation with given id operationId: GhostContactAccountAccountRoleRelations.get summary: GhostContactAccountAccountRoleRelations.get tags: - Contact parameters: - name: id in: path description: ID of GhostContactAccountAccountRoleRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: GhostContactAccountAccountRoleRelation 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/GhostContactAccountAccountRoleRelation' '404': description: Sent when 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 GhostContactAccountAccountRoleRelation with given id operationId: GhostContactAccountAccountRoleRelations.delete summary: GhostContactAccountAccountRoleRelations.delete tags: - Contact parameters: - name: id in: path description: ID of GhostContactAccountAccountRoleRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 GhostContactAccountAccountRoleRelation 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 GhostContactAccountAccountRoleRelation or GhostContactAccountAccountRoleRelations with given id(s) parameters: - name: id in: path description: ID of GhostContactAccountAccountRoleRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: GhostContactAccountAccountRoleRelations.update summary: GhostContactAccountAccountRoleRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostContactAccountAccountRoleRelationInput' responses: '200': description: Modification confirmation. Returns resulting GhostContactAccountAccountRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' '404': description: Sent when 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/GhostContactAccountAccountRoleRelations: get: description: Returns all defined GhostContactAccountAccountRoleRelations operationId: GhostContactAccountAccountRoleRelations.list summary: GhostContactAccountAccountRoleRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted GhostContactAccountAccountRoleRelations 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 GhostContactAccountAccountRoleRelations 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/GhostContactAccountAccountRoleRelation' 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 GhostContactAccountAccountRoleRelation operationId: GhostContactAccountAccountRoleRelations.create summary: GhostContactAccountAccountRoleRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountAccountRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostContactAccountAccountRoleRelationInput' responses: '201': description: Creation confirmation. Returns created GhostContactAccountAccountRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContactAccountAccountRoleRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountAccountRoleRelations/batch-delete: post: description: Removes GhostContactAccountAccountRoleRelations with given list of ids operationId: GhostContactAccountAccountRoleRelations.batch_delete summary: GhostContactAccountAccountRoleRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContactAccountAccountRoleRelations. 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 GhostContactAccountAccountRoleRelation 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 GhostContactAccountAccountRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountAccountRoleRelations/batch-modify: post: description: Create or update an batch of GhostContactAccountAccountRoleRelations operationId: GhostContactAccountAccountRoleRelations.batch_create_or_update summary: GhostContactAccountAccountRoleRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountAccountRoleRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchGhostContactAccountAccountRoleRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated GhostContactAccountAccountRoleRelations 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/GhostContactAccountAccountRoleRelations/batch-restore: post: description: Restores GhostContactAccountAccountRoleRelations with given list of ids operationId: GhostContactAccountAccountRoleRelations.batch_restore summary: GhostContactAccountAccountRoleRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountAccountRoleRelations 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 GhostContactAccountAccountRoleRelations. 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 GhostContactAccountAccountRoleRelation 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 GhostContactAccountAccountRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountRelations/{id}: get: description: Returns GhostContactAccountRelation with given id operationId: GhostContactAccountRelations.get summary: GhostContactAccountRelations.get tags: - Contact parameters: - name: id in: path description: ID of GhostContactAccountRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: GhostContactAccountRelation 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/GhostContactAccountRelation' '404': description: Sent when 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 GhostContactAccountRelation with given id operationId: GhostContactAccountRelations.delete summary: GhostContactAccountRelations.delete tags: - Contact parameters: - name: id in: path description: ID of GhostContactAccountRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 GhostContactAccountRelation 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 GhostContactAccountRelation or GhostContactAccountRelations with given id(s) parameters: - name: id in: path description: ID of GhostContactAccountRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: GhostContactAccountRelations.update summary: GhostContactAccountRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostContactAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting GhostContactAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContactAccountRelation' '404': description: Sent when 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/GhostContactAccountRelations: get: description: Returns all defined GhostContactAccountRelations operationId: GhostContactAccountRelations.list summary: GhostContactAccountRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted GhostContactAccountRelations 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 GhostContactAccountRelations 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/GhostContactAccountRelation' 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 GhostContactAccountRelation operationId: GhostContactAccountRelations.create summary: GhostContactAccountRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostContactAccountRelationInput' responses: '201': description: Creation confirmation. Returns created GhostContactAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostContactAccountRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountRelations/batch-delete: post: description: Removes GhostContactAccountRelations with given list of ids operationId: GhostContactAccountRelations.batch_delete summary: GhostContactAccountRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContactAccountRelations. 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 GhostContactAccountRelation 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 GhostContactAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostContactAccountRelations/batch-modify: post: description: Create or update an batch of GhostContactAccountRelations operationId: GhostContactAccountRelations.batch_create_or_update summary: GhostContactAccountRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new GhostContactAccountRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchGhostContactAccountRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated GhostContactAccountRelations 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/GhostContactAccountRelations/batch-restore: post: description: Restores GhostContactAccountRelations with given list of ids operationId: GhostContactAccountRelations.batch_restore summary: GhostContactAccountRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostContactAccountRelations 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 GhostContactAccountRelations. 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 GhostContactAccountRelation 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 GhostContactAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactRelations/{id}: get: description: Returns GhostLeadOpptyContactRelation with given id operationId: GhostLeadOpptyContactRelations.get summary: GhostLeadOpptyContactRelations.get tags: - Contact parameters: - name: id in: path description: ID of GhostLeadOpptyContactRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: GhostLeadOpptyContactRelation 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/GhostLeadOpptyContactRelation' '404': description: Sent when 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 GhostLeadOpptyContactRelation with given id operationId: GhostLeadOpptyContactRelations.delete summary: GhostLeadOpptyContactRelations.delete tags: - Contact parameters: - name: id in: path description: ID of GhostLeadOpptyContactRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 GhostLeadOpptyContactRelation 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 GhostLeadOpptyContactRelation or GhostLeadOpptyContactRelations with given id(s) parameters: - name: id in: path description: ID of GhostLeadOpptyContactRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: GhostLeadOpptyContactRelations.update summary: GhostLeadOpptyContactRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostLeadOpptyContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting GhostLeadOpptyContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' '404': description: Sent when 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/GhostLeadOpptyContactRelations: get: description: Returns all defined GhostLeadOpptyContactRelations operationId: GhostLeadOpptyContactRelations.list summary: GhostLeadOpptyContactRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted GhostLeadOpptyContactRelations 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 GhostLeadOpptyContactRelations 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/GhostLeadOpptyContactRelation' 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 GhostLeadOpptyContactRelation operationId: GhostLeadOpptyContactRelations.create summary: GhostLeadOpptyContactRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostLeadOpptyContactRelationInput' responses: '201': description: Creation confirmation. Returns created GhostLeadOpptyContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostLeadOpptyContactRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactRelations/batch-delete: post: description: Removes GhostLeadOpptyContactRelations with given list of ids operationId: GhostLeadOpptyContactRelations.batch_delete summary: GhostLeadOpptyContactRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostLeadOpptyContactRelations. 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 GhostLeadOpptyContactRelation 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 GhostLeadOpptyContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactRelations/batch-modify: post: description: Create or update an batch of GhostLeadOpptyContactRelations operationId: GhostLeadOpptyContactRelations.batch_create_or_update summary: GhostLeadOpptyContactRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchGhostLeadOpptyContactRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactRelations 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/GhostLeadOpptyContactRelations/batch-restore: post: description: Restores GhostLeadOpptyContactRelations with given list of ids operationId: GhostLeadOpptyContactRelations.batch_restore summary: GhostLeadOpptyContactRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactRelations 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 GhostLeadOpptyContactRelations. 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 GhostLeadOpptyContactRelation 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 GhostLeadOpptyContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactSalesRoleRelations/{id}: get: description: Returns GhostLeadOpptyContactSalesRoleRelation with given id operationId: GhostLeadOpptyContactSalesRoleRelations.get summary: GhostLeadOpptyContactSalesRoleRelations.get tags: - Contact parameters: - name: id in: path description: ID of GhostLeadOpptyContactSalesRoleRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: GhostLeadOpptyContactSalesRoleRelation 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/GhostLeadOpptyContactSalesRoleRelation' '404': description: Sent when 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 GhostLeadOpptyContactSalesRoleRelation with given id operationId: GhostLeadOpptyContactSalesRoleRelations.delete summary: GhostLeadOpptyContactSalesRoleRelations.delete tags: - Contact parameters: - name: id in: path description: ID of GhostLeadOpptyContactSalesRoleRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' 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 GhostLeadOpptyContactSalesRoleRelation 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 GhostLeadOpptyContactSalesRoleRelation or GhostLeadOpptyContactSalesRoleRelations with given id(s) parameters: - name: id in: path description: ID of GhostLeadOpptyContactSalesRoleRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: GhostLeadOpptyContactSalesRoleRelations.update summary: GhostLeadOpptyContactSalesRoleRelations.update tags: - Contact requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateGhostLeadOpptyContactSalesRoleRelationInput' responses: '200': description: Modification confirmation. Returns resulting GhostLeadOpptyContactSalesRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' '404': description: Sent when 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/GhostLeadOpptyContactSalesRoleRelations: get: description: Returns all defined GhostLeadOpptyContactSalesRoleRelations operationId: GhostLeadOpptyContactSalesRoleRelations.list summary: GhostLeadOpptyContactSalesRoleRelations.list tags: - Contact parameters: - name: include-deleted in: query description: if enabled, deleted GhostLeadOpptyContactSalesRoleRelations 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 GhostLeadOpptyContactSalesRoleRelations 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/GhostLeadOpptyContactSalesRoleRelation' 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 GhostLeadOpptyContactSalesRoleRelation operationId: GhostLeadOpptyContactSalesRoleRelations.create summary: GhostLeadOpptyContactSalesRoleRelations.create tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactSalesRoleRelation required: true content: application / json: schema: $ref: '#/components/schemas/createGhostLeadOpptyContactSalesRoleRelationInput' responses: '201': description: Creation confirmation. Returns created GhostLeadOpptyContactSalesRoleRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/GhostLeadOpptyContactSalesRoleRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactSalesRoleRelations/batch-delete: post: description: Removes GhostLeadOpptyContactSalesRoleRelations with given list of ids operationId: GhostLeadOpptyContactSalesRoleRelations.batch_delete summary: GhostLeadOpptyContactSalesRoleRelations.batch_delete tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 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 GhostLeadOpptyContactSalesRoleRelation 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 GhostLeadOpptyContactSalesRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/GhostLeadOpptyContactSalesRoleRelations/batch-modify: post: description: Create or update an batch of GhostLeadOpptyContactSalesRoleRelations operationId: GhostLeadOpptyContactSalesRoleRelations.batch_create_or_update summary: GhostLeadOpptyContactSalesRoleRelations.batch_create_or_update tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new GhostLeadOpptyContactSalesRoleRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchGhostLeadOpptyContactSalesRoleRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactSalesRoleRelations 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/GhostLeadOpptyContactSalesRoleRelations/batch-restore: post: description: Restores GhostLeadOpptyContactSalesRoleRelations with given list of ids operationId: GhostLeadOpptyContactSalesRoleRelations.batch_restore summary: GhostLeadOpptyContactSalesRoleRelations.batch_restore tags: - Contact parameters: - name: validation-level in: query description: 'Specify validation level of GhostLeadOpptyContactSalesRoleRelations 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 GhostLeadOpptyContactSalesRoleRelations. 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 GhostLeadOpptyContactSalesRoleRelation 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 GhostLeadOpptyContactSalesRoleRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: updateContactAccountAccountRoleRelationInput: properties: contact_account_relation: type: object properties: id: type: string format: uri description: 'Contact-account link this role assignment belongs to. Relation to ContactAccountRelation, see: ''updateContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact-account link. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchGhostContactAccountAccountRoleRelationInput: properties: ghost_contact_account_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-account placement this role assignment belongs to. Relation to GhostContactAccountRelation, see: ''updateGhostContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. ghost_contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-account placement. 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 createGhostContactAccountRelationInput: 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 ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the account org chart. Relation to GhostContact, see: ''createGhostContactInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. is_assistant: type: boolean example: false description: True when the ghost contact is rendered as an assistant of its parent in the org chart. is_sibling: type: boolean example: false description: True when the ghost contact is rendered as a sibling rather than a child in the org chart. position: type: string example: string description: Position label shown on the org chart for the ghost contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to GhostContactAccountAccountRoleRelation, see: ''createGhostContactAccountAccountRoleRelationInput'' object for properties.' description: Account roles assigned to the ghost contact on this account. required: - ghost_contact - account_id - ghost_contact_id GhostContactAccountRelation: 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 whose org chart includes the ghost contact. 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.' ghost_contact: type: string format: uri description: 'Placeholder ghost contact placed on the account org chart. Relation to GhostContact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostContact'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. is_assistant: type: boolean example: false description: True when the ghost contact is rendered as an assistant of its parent in the org chart. is_sibling: type: boolean example: false description: True when the ghost contact is rendered as a sibling rather than a child in the org chart. position: type: string example: string description: Position label shown on the org chart for the ghost contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_roles: type: array items: type: string format: uri description: 'Relation to GhostContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostContactAccountAccountRoleRelation'' object for properties.' description: Account roles assigned to the ghost contact on this account. required: - is_delete_protected - id - account - ghost_contact - account_id - ghost_contact_id ContactAccountAccountRoleRelation: 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_role: type: string format: uri description: 'Role assigned to the contact at the account. Relation to AccountRole. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountRole'' object for properties.' contact_account_relation: type: string format: uri description: 'Contact-account link this role assignment belongs to. Relation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactAccountRelation'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact-account link. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account_role - contact_account_relation - account_role_id - contact_account_relation_id batchGhostContactInput: properties: name: type: string example: string description: Name of the entity and its default text representation. position: type: string example: string description: Job title or position of the placeholder contact (org-chart label). 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 ContactSharingSalesUnitRelation: 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 being shared. 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.' unit: type: string format: uri description: 'Sales unit the contact 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.' contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact. 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 - contact - unit - contact_id - unit_id updateGhostContactAccountAccountRoleRelationInput: properties: ghost_contact_account_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-account placement this role assignment belongs to. Relation to GhostContactAccountRelation, see: ''updateGhostContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. ghost_contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-account placement. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchContactRelationInput: properties: contact1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related contact. contact2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related contact. 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 ContactSocialRelation: 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 Contact id. 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 angellist_url: type: string example: string description: AngelList profile URL of the contact. crunchbase_url: type: string example: string description: Crunchbase profile URL of the contact. disqus_url: type: string example: string description: Disqus profile URL of the contact. facebook_id: type: string example: string description: Facebook profile id of the contact. facebook_url: type: string example: string description: Facebook profile URL of the contact. flickr_url: type: string example: string description: Flickr profile URL of the contact. foursquare_url: type: string example: string description: Foursquare profile URL of the contact. google_id: type: string example: string description: Google profile id of the contact. google_plus_url: type: string example: string description: Google+ profile URL of the contact. gravatar_url: type: string example: string description: Gravatar profile URL of the contact. klout_url: type: string example: string description: Klout profile URL of the contact. linkedin_id: type: string example: string description: LinkedIn profile id of the contact. linkedin_url: type: string example: string description: LinkedIn profile URL of the contact. pinterest_url: type: string example: string description: Pinterest profile URL of the contact. quora_url: type: string example: string description: Quora profile URL of the contact. reddit_url: type: string example: string description: Reddit profile URL of the contact. skype_url: type: string example: string description: Skype contact URL or username of the contact. slideshare_url: type: string example: string description: SlideShare profile URL of the contact. twitter_id: type: string example: string description: Twitter (X) user id of the contact. twitter_url: type: string example: string description: Twitter (X) profile URL of the contact. vimeo_url: type: string example: string description: Vimeo profile URL of the contact. wordpress_url: type: string example: string description: WordPress site URL of the contact. xing_url: type: string example: string description: XING profile URL of the contact. yahoo_url: type: string example: string description: Yahoo profile URL of the contact. yelp_url: type: string example: string description: Yelp profile URL of the contact. youtube_url: type: string example: string description: YouTube channel URL of the contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id batchContactKPIInput: 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. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. kpi: type: integer description: 'KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact 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 batchContactSharingSalesUnitRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact. 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 batchContactInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. picture: type: object properties: id: type: string format: uri description: 'Profile picture associated with the contact. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' address: type: string example: string description: Street address of the contact. city: type: string example: string description: City of the contact address. comments: type: string example: string description: Free-form notes describing the contact. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact type assigned to this contact. country: type: string example: string description: Country of the contact address. 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 contact. email1: type: string example: string description: Primary email address of the contact. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. first_name: type: string example: string description: Given name of the contact. gender: type: integer description: 'Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' example: 0 enum: - 0 - 1 - 2 - 3 is_archived: type: boolean example: false description: True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. last_name: type: string example: string description: Family name of the contact. middle_name: type: string example: string description: Middle name of the contact, if applicable. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact owner. phone1: type: string example: string description: Primary phone number of the contact. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. position: type: string example: string description: Job title or position of the contact. quick_account_name: type: string example: string description: Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. 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 state_province: type: string example: string description: State or province of the contact address. title: type: string example: string description: Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the contact address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Relation to ContactSocialRelation, see: ''updateContactSocialRelationInput'' object for properties.' account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountRelation, see: ''updateContactAccountRelationInput'' object for properties.' description: Accounts this contact is linked to. Each link records the role and position the contact has at the related account. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingSalesUnitRelation, see: ''updateContactSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingClientRelation, see: ''updateContactSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this contact. 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 contact. exchange_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. gapi_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. o365_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. primary_account_account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''updateContactAccountAccountRoleRelationInput'' object for properties.' description: Roles of Contact in his primary Account. account_position: type: string example: string description: Job position of Contact in his primary Account or quick account position if Contact has no primary Account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. 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 contact. 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 contact currently matches. primary_account_relationship: type: string example: string description: Org chart relationship of Contact in his primary Account. id: description: ID of object to update. type: string format: uuid GhostContact: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. position: type: string example: string description: Job title or position of the placeholder contact (org-chart label). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - name batchContactSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact. 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 createContactSharingClientRelationInput: 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. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact. 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 - contact_id updateContactInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. picture: type: object properties: id: type: string format: uri description: 'Profile picture associated with the contact. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' address: type: string example: string description: Street address of the contact. city: type: string example: string description: City of the contact address. comments: type: string example: string description: Free-form notes describing the contact. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact type assigned to this contact. country: type: string example: string description: Country of the contact address. 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 contact. email1: type: string example: string description: Primary email address of the contact. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. first_name: type: string example: string description: Given name of the contact. gender: type: integer description: 'Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' example: 0 enum: - 0 - 1 - 2 - 3 is_archived: type: boolean example: false description: True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. last_name: type: string example: string description: Family name of the contact. middle_name: type: string example: string description: Middle name of the contact, if applicable. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact owner. phone1: type: string example: string description: Primary phone number of the contact. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. position: type: string example: string description: Job title or position of the contact. quick_account_name: type: string example: string description: Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. 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 state_province: type: string example: string description: State or province of the contact address. title: type: string example: string description: Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the contact address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Relation to ContactSocialRelation, see: ''updateContactSocialRelationInput'' object for properties.' account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountRelation, see: ''updateContactAccountRelationInput'' object for properties.' description: Accounts this contact is linked to. Each link records the role and position the contact has at the related account. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingSalesUnitRelation, see: ''updateContactSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingClientRelation, see: ''updateContactSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this contact. 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 contact. exchange_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. gapi_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. o365_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. primary_account_account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''updateContactAccountAccountRoleRelationInput'' object for properties.' description: Roles of Contact in his primary Account. account_position: type: string example: string description: Job position of Contact in his primary Account or quick account position if Contact has no primary Account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. 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 contact. 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 contact currently matches. primary_account_relationship: type: string example: string description: Org chart relationship of Contact in his primary Account. 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 GhostLeadOpptyContactRelation: 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 ghost_contact: type: string format: uri description: 'Placeholder ghost contact placed on the lead/opportunity org chart. Relation to GhostContact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostContact'' object for properties.' lead_oppty_contact_group_relation: type: string format: uri description: 'Org-chart group the ghost contact belongs to, when grouped. 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 whose org chart includes the ghost contact. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity whose org chart includes the ghost contact. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent org-chart group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity. position_in_group: type: object description: 'Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }.' 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 GhostLeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostLeadOpptyContactSalesRoleRelation'' object for properties.' description: Sales roles assigned to the ghost contact on this lead/opportunity. required: - is_delete_protected - id - ghost_contact - ghost_contact_id - lead_oppty_id updateContactSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact. 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. ContactAccountRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account the contact is linked to. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' contact: type: string format: uri description: 'Contact linked to the account. 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.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-form note describing this contact-account link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_assistant: type: boolean example: false description: True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. 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. is_sibling: type: boolean example: false description: True when the contact is a sibling node on the account org chart (no parent/child reporting line). position: type: string example: string description: Job title or position the contact holds at the account. relationship: type: integer description: 'Org-chart relationship of the contact within the account 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. account_roles: type: array items: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactAccountAccountRoleRelation'' object for properties.' description: Roles the contact holds within the linked account. required: - is_delete_protected - id - account - contact - account_id - contact_id - is_primary createGhostContactInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. position: type: string example: string description: Job title or position of the placeholder contact (org-chart label). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - name batchGhostContactAccountRelationInput: properties: ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the account org chart. Relation to GhostContact, see: ''updateGhostContactInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. is_assistant: type: boolean example: false description: True when the ghost contact is rendered as an assistant of its parent in the org chart. is_sibling: type: boolean example: false description: True when the ghost contact is rendered as a sibling rather than a child in the org chart. position: type: string example: string description: Position label shown on the org chart for the ghost contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to GhostContactAccountAccountRoleRelation, see: ''updateGhostContactAccountAccountRoleRelationInput'' object for properties.' description: Account roles assigned to the ghost contact on this account. id: description: ID of object to update. type: string format: uuid createContactSocialRelationInput: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with Contact id. 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 angellist_url: type: string example: string description: AngelList profile URL of the contact. crunchbase_url: type: string example: string description: Crunchbase profile URL of the contact. disqus_url: type: string example: string description: Disqus profile URL of the contact. facebook_id: type: string example: string description: Facebook profile id of the contact. facebook_url: type: string example: string description: Facebook profile URL of the contact. flickr_url: type: string example: string description: Flickr profile URL of the contact. foursquare_url: type: string example: string description: Foursquare profile URL of the contact. google_id: type: string example: string description: Google profile id of the contact. google_plus_url: type: string example: string description: Google+ profile URL of the contact. gravatar_url: type: string example: string description: Gravatar profile URL of the contact. klout_url: type: string example: string description: Klout profile URL of the contact. linkedin_id: type: string example: string description: LinkedIn profile id of the contact. linkedin_url: type: string example: string description: LinkedIn profile URL of the contact. pinterest_url: type: string example: string description: Pinterest profile URL of the contact. quora_url: type: string example: string description: Quora profile URL of the contact. reddit_url: type: string example: string description: Reddit profile URL of the contact. skype_url: type: string example: string description: Skype contact URL or username of the contact. slideshare_url: type: string example: string description: SlideShare profile URL of the contact. twitter_id: type: string example: string description: Twitter (X) user id of the contact. twitter_url: type: string example: string description: Twitter (X) profile URL of the contact. vimeo_url: type: string example: string description: Vimeo profile URL of the contact. wordpress_url: type: string example: string description: WordPress site URL of the contact. xing_url: type: string example: string description: XING profile URL of the contact. yahoo_url: type: string example: string description: Yahoo profile URL of the contact. yelp_url: type: string example: string description: Yelp profile URL of the contact. youtube_url: type: string example: string description: YouTube channel URL of the contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - id createGhostLeadOpptyContactSalesRoleRelationInput: 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 ghost_lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Relation to GhostLeadOpptyContactRelation, see: ''createGhostLeadOpptyContactRelationInput'' object for properties.' ghost_lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-lead/opportunity placement. 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: - ghost_lead_oppty_contact_relation - ghost_lead_oppty_contact_relation_id - sales_role_id ContactRelationType: 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 relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - color ContactKPI: 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 or archived the contact, sent the first email). 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.' contact: type: string format: uri description: 'Contact this KPI event relates to. 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.' owner: type: string format: uri description: 'Contact 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. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. kpi: type: integer description: 'KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact 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 - contact - owner - contact_id - kpi - owner_id updateContactSocialRelationInput: properties: angellist_url: type: string example: string description: AngelList profile URL of the contact. crunchbase_url: type: string example: string description: Crunchbase profile URL of the contact. disqus_url: type: string example: string description: Disqus profile URL of the contact. facebook_id: type: string example: string description: Facebook profile id of the contact. facebook_url: type: string example: string description: Facebook profile URL of the contact. flickr_url: type: string example: string description: Flickr profile URL of the contact. foursquare_url: type: string example: string description: Foursquare profile URL of the contact. google_id: type: string example: string description: Google profile id of the contact. google_plus_url: type: string example: string description: Google+ profile URL of the contact. gravatar_url: type: string example: string description: Gravatar profile URL of the contact. klout_url: type: string example: string description: Klout profile URL of the contact. linkedin_id: type: string example: string description: LinkedIn profile id of the contact. linkedin_url: type: string example: string description: LinkedIn profile URL of the contact. pinterest_url: type: string example: string description: Pinterest profile URL of the contact. quora_url: type: string example: string description: Quora profile URL of the contact. reddit_url: type: string example: string description: Reddit profile URL of the contact. skype_url: type: string example: string description: Skype contact URL or username of the contact. slideshare_url: type: string example: string description: SlideShare profile URL of the contact. twitter_id: type: string example: string description: Twitter (X) user id of the contact. twitter_url: type: string example: string description: Twitter (X) profile URL of the contact. vimeo_url: type: string example: string description: Vimeo profile URL of the contact. wordpress_url: type: string example: string description: WordPress site URL of the contact. xing_url: type: string example: string description: XING profile URL of the contact. yahoo_url: type: string example: string description: Yahoo profile URL of the contact. yelp_url: type: string example: string description: Yelp profile URL of the contact. youtube_url: type: string example: string description: YouTube channel URL of the contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateGhostContactInput: properties: name: type: string example: string description: Name of the entity and its default text representation. position: type: string example: string description: Job title or position of the placeholder contact (org-chart label). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchContactAccountAccountRoleRelationInput: properties: contact_account_relation: type: object properties: id: type: string format: uri description: 'Contact-account link this role assignment belongs to. Relation to ContactAccountRelation, see: ''updateContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact-account link. 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 createContactRelationTypeInput: 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 relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - color ContactDataExRelation: 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 this data relation row applies to. 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.' data: type: string format: uri description: 'Data record holding the additional fields linked to this contact. 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.' contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. 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. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - contact - data - contact_id - data_id - data_set_id GhostContactAccountAccountRoleRelation: 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_role: type: string format: uri description: 'Account role assigned to the ghost contact. Relation to AccountRole. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountRole'' object for properties.' ghost_contact_account_relation: type: string format: uri description: 'Ghost-contact-on-account placement this role assignment belongs to. Relation to GhostContactAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostContactAccountRelation'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. ghost_contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-account placement. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account_role - ghost_contact_account_relation - account_role_id - ghost_contact_account_relation_id updateGhostContactAccountRelationInput: properties: ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the account org chart. Relation to GhostContact, see: ''updateGhostContactInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. is_assistant: type: boolean example: false description: True when the ghost contact is rendered as an assistant of its parent in the org chart. is_sibling: type: boolean example: false description: True when the ghost contact is rendered as a sibling rather than a child in the org chart. position: type: string example: string description: Position label shown on the org chart for the ghost contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to GhostContactAccountAccountRoleRelation, see: ''updateGhostContactAccountAccountRoleRelationInput'' object for properties.' description: Account roles assigned to the ghost contact on this account. batchGhostLeadOpptyContactSalesRoleRelationInput: properties: ghost_lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Relation to GhostLeadOpptyContactRelation, see: ''updateGhostLeadOpptyContactRelationInput'' object for properties.' ghost_lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-lead/opportunity placement. 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 updateContactRelationInput: properties: contact1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related contact. contact2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. ContactType: 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 edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the contact 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. 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: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name - settings GhostLeadOpptyContactSalesRoleRelation: 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 ghost_lead_oppty_contact_relation: type: string format: uri description: 'Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Relation to GhostLeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''GhostLeadOpptyContactRelation'' object for properties.' sales_role: type: string format: uri description: 'Sales role assigned to the ghost contact. 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.' ghost_lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-lead/opportunity placement. 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 - ghost_lead_oppty_contact_relation - sales_role - ghost_lead_oppty_contact_relation_id - sales_role_id updateContactAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-form note describing this contact-account link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_assistant: type: boolean example: false description: True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. 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. is_sibling: type: boolean example: false description: True when the contact is a sibling node on the account org chart (no parent/child reporting line). position: type: string example: string description: Job title or position the contact holds at the account. relationship: type: integer description: 'Org-chart relationship of the contact within the account 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. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''updateContactAccountAccountRoleRelationInput'' object for properties.' description: Roles the contact holds within the linked account. updateGhostLeadOpptyContactRelationInput: properties: ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the lead/opportunity org chart. Relation to GhostContact, see: ''updateGhostContactInput'' object for properties.' lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Org-chart group the ghost contact belongs to, when grouped. Relation to LeadOpptyContactGroupRelation, see: ''updateLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent org-chart group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity. position_in_group: type: object description: 'Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }.' 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 GhostLeadOpptyContactSalesRoleRelation, see: ''updateGhostLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the ghost contact on this lead/opportunity. updateContactSharingSalesUnitRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact. 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. updateContactKPIInput: 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. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. kpi: type: integer description: 'KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact 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. batchContactTypeInput: properties: form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the contact 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. 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 ContactRelation: 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 contact1: type: string format: uri description: 'One side of the contact-to-contact relationship. 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.' contact2: type: string format: uri description: 'Other side of the contact-to-contact relationship. 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.' contact1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related contact. contact2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - contact1 - contact2 - contact1_id - contact2_id batchContactRelationLabelInput: properties: contact_relation: type: object properties: id: type: string format: uri description: 'Contact relationship being labelled. Relation to ContactRelation, see: ''updateContactRelationInput'' object for properties.' contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact relationship. contact_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship 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 createContactKPIInput: 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. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. kpi: type: integer description: 'KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact 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: - contact_id - kpi - owner_id createContactAccountAccountRoleRelationInput: 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 contact_account_relation: type: object properties: id: type: string format: uri description: 'Contact-account link this role assignment belongs to. Relation to ContactAccountRelation, see: ''createContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact-account link. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - contact_account_relation - account_role_id - contact_account_relation_id batchContactAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. comment: type: string example: string description: Free-form note describing this contact-account link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_assistant: type: boolean example: false description: True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. 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. is_sibling: type: boolean example: false description: True when the contact is a sibling node on the account org chart (no parent/child reporting line). position: type: string example: string description: Job title or position the contact holds at the account. relationship: type: integer description: 'Org-chart relationship of the contact within the account 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. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''updateContactAccountAccountRoleRelationInput'' object for properties.' description: Roles the contact holds within the linked account. id: description: ID of object to update. type: string format: uuid createContactAccountRelationInput: 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. comment: type: string example: string description: Free-form note describing this contact-account link. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_assistant: type: boolean example: false description: True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. 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. is_sibling: type: boolean example: false description: True when the contact is a sibling node on the account org chart (no parent/child reporting line). position: type: string example: string description: Job title or position the contact holds at the account. relationship: type: integer description: 'Org-chart relationship of the contact within the account 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. account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''createContactAccountAccountRoleRelationInput'' object for properties.' description: Roles the contact holds within the linked account. required: - account_id - contact_id - is_primary createGhostLeadOpptyContactRelationInput: 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 ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the lead/opportunity org chart. Relation to GhostContact, see: ''createGhostContactInput'' object for properties.' lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Org-chart group the ghost contact belongs to, when grouped. Relation to LeadOpptyContactGroupRelation, see: ''createLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent org-chart group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity. position_in_group: type: object description: 'Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }.' 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 GhostLeadOpptyContactSalesRoleRelation, see: ''createGhostLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the ghost contact on this lead/opportunity. required: - ghost_contact - ghost_contact_id - lead_oppty_id updateGhostLeadOpptyContactSalesRoleRelationInput: properties: ghost_lead_oppty_contact_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Relation to GhostLeadOpptyContactRelation, see: ''updateGhostLeadOpptyContactRelationInput'' object for properties.' ghost_lead_oppty_contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-lead/opportunity placement. 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. updateContactRelationLabelInput: properties: contact_relation: type: object properties: id: type: string format: uri description: 'Contact relationship being labelled. Relation to ContactRelation, see: ''updateContactRelationInput'' object for properties.' contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact relationship. contact_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createContactTypeInput: 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 edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the contact 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. 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 - settings createContactRelationInput: 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 contact1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related contact. contact2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related contact. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - contact1_id - contact2_id ContactSharingClientRelation: 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 contact 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.' contact: type: string format: uri description: 'Contact being shared. 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.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact. 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 - contact - client_id - contact_id batchContactRelationTypeInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). 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 Contact: 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. contact_type: type: string format: uri description: 'Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. Relation to ContactType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactType'' object for properties.' currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CurrencyExchangeRatesList'' object for properties.' owner: type: string format: uri description: 'Sales user who owns this contact. 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.' picture: type: string format: uri description: 'Profile picture associated with the contact. 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.' unit: type: string format: uri description: 'Sales unit this contact 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.' address: type: string example: string description: Street address of the contact. city: type: string example: string description: City of the contact address. comments: type: string example: string description: Free-form notes describing the contact. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact type assigned to this contact. country: type: string example: string description: Country of the contact address. 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 contact. email1: type: string example: string description: Primary email address of the contact. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. first_name: type: string example: string description: Given name of the contact. gender: type: integer description: 'Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' example: 0 enum: - 0 - 1 - 2 - 3 is_archived: type: boolean example: false description: True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. last_name: type: string example: string description: Family name of the contact. middle_name: type: string example: string description: Middle name of the contact, if applicable. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact owner. phone1: type: string example: string description: Primary phone number of the contact. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. position: type: string example: string description: Job title or position of the contact. quick_account_name: type: string example: string description: Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. 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 state_province: type: string example: string description: State or province of the contact address. title: type: string example: string description: Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the contact address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. formatted_name: type: string example: string description: Display version of the contact name (title, first, middle, last). Used in lists and references. social_media: type: string format: uri description: 'Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Relation to ContactSocialRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactSocialRelation'' object for properties.' primary_account: type: string format: uri description: 'Primary account this contact belongs to. Set automatically when the contact has an 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.' account_relations: type: array items: type: string format: uri description: 'Relation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactAccountRelation'' object for properties.' description: Accounts this contact is linked to. Each link records the role and position the contact has at the related account. sharing_units: type: array items: type: string format: uri description: 'Relation to ContactSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactSharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: string format: uri description: 'Relation to ContactSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactSharingClientRelation'' object for properties.' description: Users that have been granted shared access to this contact. 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 contact. exchange_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. gapi_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. o365_entity_id: type: string example: string description: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this contact as favorite. Per-user. primary_account_account_roles: type: array items: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactAccountAccountRoleRelation'' object for properties.' description: Roles of Contact in his primary Account. primary_account_position: type: string example: string description: Job position of Contact in his primary Account. account_position: type: string example: string description: Job position of Contact in his primary Account or quick account position if Contact has no primary Account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. 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 contact. 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 contact currently matches. primary_account_relationship: type: string example: string description: Org chart relationship of Contact in his primary Account. 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 - contact_type - owner - unit - owner_id - formatted_name - is_favorite batchGhostLeadOpptyContactRelationInput: properties: ghost_contact: type: object properties: id: type: string format: uri description: 'Placeholder ghost contact placed on the lead/opportunity org chart. Relation to GhostContact, see: ''updateGhostContactInput'' object for properties.' lead_oppty_contact_group_relation: type: object properties: id: type: string format: uri description: 'Org-chart group the ghost contact belongs to, when grouped. Relation to LeadOpptyContactGroupRelation, see: ''updateLeadOpptyContactGroupRelationInput'' object for properties.' comment: type: string example: string description: Free-text comment shown on the org-chart node. ghost_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost contact. lead_oppty_contact_group_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent org-chart group. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity. position_in_group: type: object description: 'Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }.' 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 GhostLeadOpptyContactSalesRoleRelation, see: ''updateGhostLeadOpptyContactSalesRoleRelationInput'' object for properties.' description: Sales roles assigned to the ghost contact on this lead/opportunity. id: description: ID of object to update. type: string format: uuid createContactInput: 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. picture: type: object properties: id: type: string format: uri description: 'Profile picture associated with the contact. Relation to CloudObject, see: ''createCloudObjectInput'' object for properties.' address: type: string example: string description: Street address of the contact. city: type: string example: string description: City of the contact address. comments: type: string example: string description: Free-form notes describing the contact. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact type assigned to this contact. country: type: string example: string description: Country of the contact address. 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 contact. email1: type: string example: string description: Primary email address of the contact. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. first_name: type: string example: string description: Given name of the contact. gender: type: integer description: 'Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary' example: 0 enum: - 0 - 1 - 2 - 3 is_archived: type: boolean example: false description: True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. last_name: type: string example: string description: Family name of the contact. middle_name: type: string example: string description: Middle name of the contact, if applicable. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact owner. phone1: type: string example: string description: Primary phone number of the contact. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. position: type: string example: string description: Job title or position of the contact. quick_account_name: type: string example: string description: Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. 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 state_province: type: string example: string description: State or province of the contact address. title: type: string example: string description: Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the contact address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Relation to ContactSocialRelation, see: ''createContactSocialRelationInput'' object for properties.' account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountRelation, see: ''createContactAccountRelationInput'' object for properties.' description: Accounts this contact is linked to. Each link records the role and position the contact has at the related account. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingSalesUnitRelation, see: ''createContactSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactSharingClientRelation, see: ''createContactSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this contact. 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 contact. primary_account_account_roles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ContactAccountAccountRoleRelation, see: ''createContactAccountAccountRoleRelationInput'' object for properties.' description: Roles of Contact in his primary Account. account_position: type: string example: string description: Job position of Contact in his primary Account or quick account position if Contact has no primary Account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. 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 contact. 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 contact currently matches. primary_account_relationship: type: string example: string description: Org chart relationship of Contact in his primary Account. required: - owner_id createContactRelationLabelInput: 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 contact_relation: type: object properties: id: type: string format: uri description: 'Contact relationship being labelled. Relation to ContactRelation, see: ''createContactRelationInput'' object for properties.' contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact relationship. contact_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - contact_relation - contact_relation_id - contact_relation_type_id createGhostContactAccountAccountRoleRelationInput: 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 ghost_contact_account_relation: type: object properties: id: type: string format: uri description: 'Ghost-contact-on-account placement this role assignment belongs to. Relation to GhostContactAccountRelation, see: ''createGhostContactAccountRelationInput'' object for properties.' account_role_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account role. ghost_contact_account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the ghost-contact-account placement. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - ghost_contact_account_relation - account_role_id - ghost_contact_account_relation_id updateContactRelationTypeInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createContactSharingSalesUnitRelationInput: 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 contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared contact. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact. 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: - contact_id - unit_id ContactRelationLabel: 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_relation: type: string format: uri description: 'Contact relationship being labelled. Relation to ContactRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactRelation'' object for properties.' contact_relation_type: type: string format: uri description: 'Type of the relationship (e.g. spouse, colleague). Relation to ContactRelationType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ContactRelationType'' object for properties.' contact_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact relationship. contact_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - contact_relation - contact_relation_type - contact_relation_id - contact_relation_type_id batchContactSocialRelationInput: properties: angellist_url: type: string example: string description: AngelList profile URL of the contact. crunchbase_url: type: string example: string description: Crunchbase profile URL of the contact. disqus_url: type: string example: string description: Disqus profile URL of the contact. facebook_id: type: string example: string description: Facebook profile id of the contact. facebook_url: type: string example: string description: Facebook profile URL of the contact. flickr_url: type: string example: string description: Flickr profile URL of the contact. foursquare_url: type: string example: string description: Foursquare profile URL of the contact. google_id: type: string example: string description: Google profile id of the contact. google_plus_url: type: string example: string description: Google+ profile URL of the contact. gravatar_url: type: string example: string description: Gravatar profile URL of the contact. klout_url: type: string example: string description: Klout profile URL of the contact. linkedin_id: type: string example: string description: LinkedIn profile id of the contact. linkedin_url: type: string example: string description: LinkedIn profile URL of the contact. pinterest_url: type: string example: string description: Pinterest profile URL of the contact. quora_url: type: string example: string description: Quora profile URL of the contact. reddit_url: type: string example: string description: Reddit profile URL of the contact. skype_url: type: string example: string description: Skype contact URL or username of the contact. slideshare_url: type: string example: string description: SlideShare profile URL of the contact. twitter_id: type: string example: string description: Twitter (X) user id of the contact. twitter_url: type: string example: string description: Twitter (X) profile URL of the contact. vimeo_url: type: string example: string description: Vimeo profile URL of the contact. wordpress_url: type: string example: string description: WordPress site URL of the contact. xing_url: type: string example: string description: XING profile URL of the contact. yahoo_url: type: string example: string description: Yahoo profile URL of the contact. yelp_url: type: string example: string description: Yelp profile URL of the contact. youtube_url: type: string example: string description: YouTube channel URL of the contact. 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 updateContactTypeInput: properties: form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the contact 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. 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.