openapi: 3.2.0
info:
  title: Pipeliner Cloud Master Right 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: MasterRight
paths:
  /entities/AllowedAccountTypes/{id}:
    get:
      description: Returns AllowedAccountType with given id
      operationId: AllowedAccountTypes.get
      summary: AllowedAccountTypes.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedAccountType to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedAccountType 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/AllowedAccountType'
        '404':
          description: Sent when 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 AllowedAccountType with given id
      operationId: AllowedAccountTypes.delete
      summary: AllowedAccountTypes.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedAccountType to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountType on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedAccountType
                    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 AllowedAccountType or AllowedAccountTypes with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedAccountType to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountType on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedAccountTypes.update
      summary: AllowedAccountTypes.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedAccountTypeInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedAccountType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedAccountType'
        '404':
          description: Sent when 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/AllowedAccountTypes:
    get:
      description: Returns all defined AllowedAccountTypes
      operationId: AllowedAccountTypes.list
      summary: AllowedAccountTypes.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedAccountTypes 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 AllowedAccountTypes
          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/AllowedAccountType'
                  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 AllowedAccountType
      operationId: AllowedAccountTypes.create
      summary: AllowedAccountTypes.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountType on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedAccountType
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedAccountTypeInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedAccountType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedAccountType'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedAccountTypes/batch-delete:
    post:
      description: Removes AllowedAccountTypes with given list of ids
      operationId: AllowedAccountTypes.batch_delete
      summary: AllowedAccountTypes.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountTypes on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedAccountTypes. 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 AllowedAccountType 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 AllowedAccountType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedAccountTypes/batch-modify:
    post:
      description: Create or update an batch of AllowedAccountTypes
      operationId: AllowedAccountTypes.batch_create_or_update
      summary: AllowedAccountTypes.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountTypes on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedAccountType
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedAccountTypeInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedAccountTypes
          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/AllowedAccountTypes/batch-restore:
    post:
      description: Restores AllowedAccountTypes with given list of ids
      operationId: AllowedAccountTypes.batch_restore
      summary: AllowedAccountTypes.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedAccountTypes 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 AllowedAccountTypes. 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 AllowedAccountType 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 AllowedAccountType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyEmails/{id}:
    get:
      description: Returns AllowedCompanyEmail with given id
      operationId: AllowedCompanyEmails.get
      summary: AllowedCompanyEmails.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyEmail to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedCompanyEmail 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/AllowedCompanyEmail'
        '404':
          description: Sent when 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 AllowedCompanyEmail with given id
      operationId: AllowedCompanyEmails.delete
      summary: AllowedCompanyEmails.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyEmail to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmail on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedCompanyEmail
                    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 AllowedCompanyEmail or AllowedCompanyEmails with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyEmail to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmail on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedCompanyEmails.update
      summary: AllowedCompanyEmails.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedCompanyEmailInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedCompanyEmail
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedCompanyEmail'
        '404':
          description: Sent when 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/AllowedCompanyEmails:
    get:
      description: Returns all defined AllowedCompanyEmails
      operationId: AllowedCompanyEmails.list
      summary: AllowedCompanyEmails.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedCompanyEmails 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 AllowedCompanyEmails
          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/AllowedCompanyEmail'
                  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 AllowedCompanyEmail
      operationId: AllowedCompanyEmails.create
      summary: AllowedCompanyEmails.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmail on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedCompanyEmail
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedCompanyEmailInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedCompanyEmail
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedCompanyEmail'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyEmails/batch-delete:
    post:
      description: Removes AllowedCompanyEmails with given list of ids
      operationId: AllowedCompanyEmails.batch_delete
      summary: AllowedCompanyEmails.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmails on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedCompanyEmails. 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 AllowedCompanyEmail 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 AllowedCompanyEmail.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyEmails/batch-modify:
    post:
      description: Create or update an batch of AllowedCompanyEmails
      operationId: AllowedCompanyEmails.batch_create_or_update
      summary: AllowedCompanyEmails.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmails on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedCompanyEmail
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedCompanyEmailInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedCompanyEmails
          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/AllowedCompanyEmails/batch-restore:
    post:
      description: Restores AllowedCompanyEmails with given list of ids
      operationId: AllowedCompanyEmails.batch_restore
      summary: AllowedCompanyEmails.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyEmails 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 AllowedCompanyEmails. 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 AllowedCompanyEmail 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 AllowedCompanyEmail.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyPhones/{id}:
    get:
      description: Returns AllowedCompanyPhone with given id
      operationId: AllowedCompanyPhones.get
      summary: AllowedCompanyPhones.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyPhone to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedCompanyPhone 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/AllowedCompanyPhone'
        '404':
          description: Sent when 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 AllowedCompanyPhone with given id
      operationId: AllowedCompanyPhones.delete
      summary: AllowedCompanyPhones.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyPhone to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhone on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedCompanyPhone
                    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 AllowedCompanyPhone or AllowedCompanyPhones with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedCompanyPhone to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhone on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedCompanyPhones.update
      summary: AllowedCompanyPhones.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedCompanyPhoneInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedCompanyPhone
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedCompanyPhone'
        '404':
          description: Sent when 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/AllowedCompanyPhones:
    get:
      description: Returns all defined AllowedCompanyPhones
      operationId: AllowedCompanyPhones.list
      summary: AllowedCompanyPhones.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedCompanyPhones 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 AllowedCompanyPhones
          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/AllowedCompanyPhone'
                  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 AllowedCompanyPhone
      operationId: AllowedCompanyPhones.create
      summary: AllowedCompanyPhones.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhone on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedCompanyPhone
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedCompanyPhoneInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedCompanyPhone
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedCompanyPhone'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyPhones/batch-delete:
    post:
      description: Removes AllowedCompanyPhones with given list of ids
      operationId: AllowedCompanyPhones.batch_delete
      summary: AllowedCompanyPhones.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhones on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedCompanyPhones. 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 AllowedCompanyPhone 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 AllowedCompanyPhone.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedCompanyPhones/batch-modify:
    post:
      description: Create or update an batch of AllowedCompanyPhones
      operationId: AllowedCompanyPhones.batch_create_or_update
      summary: AllowedCompanyPhones.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhones on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedCompanyPhone
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedCompanyPhoneInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedCompanyPhones
          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/AllowedCompanyPhones/batch-restore:
    post:
      description: Restores AllowedCompanyPhones with given list of ids
      operationId: AllowedCompanyPhones.batch_restore
      summary: AllowedCompanyPhones.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedCompanyPhones 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 AllowedCompanyPhones. 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 AllowedCompanyPhone 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 AllowedCompanyPhone.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedContactTypes/{id}:
    get:
      description: Returns AllowedContactType with given id
      operationId: AllowedContactTypes.get
      summary: AllowedContactTypes.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedContactType to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedContactType 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/AllowedContactType'
        '404':
          description: Sent when 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 AllowedContactType with given id
      operationId: AllowedContactTypes.delete
      summary: AllowedContactTypes.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedContactType to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactType on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedContactType
                    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 AllowedContactType or AllowedContactTypes with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedContactType to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactType on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedContactTypes.update
      summary: AllowedContactTypes.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedContactTypeInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedContactType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedContactType'
        '404':
          description: Sent when 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/AllowedContactTypes:
    get:
      description: Returns all defined AllowedContactTypes
      operationId: AllowedContactTypes.list
      summary: AllowedContactTypes.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedContactTypes 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 AllowedContactTypes
          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/AllowedContactType'
                  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 AllowedContactType
      operationId: AllowedContactTypes.create
      summary: AllowedContactTypes.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactType on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedContactType
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedContactTypeInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedContactType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedContactType'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedContactTypes/batch-delete:
    post:
      description: Removes AllowedContactTypes with given list of ids
      operationId: AllowedContactTypes.batch_delete
      summary: AllowedContactTypes.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactTypes on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedContactTypes. 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 AllowedContactType 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 AllowedContactType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedContactTypes/batch-modify:
    post:
      description: Create or update an batch of AllowedContactTypes
      operationId: AllowedContactTypes.batch_create_or_update
      summary: AllowedContactTypes.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactTypes on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedContactType
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedContactTypeInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedContactTypes
          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/AllowedContactTypes/batch-restore:
    post:
      description: Restores AllowedContactTypes with given list of ids
      operationId: AllowedContactTypes.batch_restore
      summary: AllowedContactTypes.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedContactTypes 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 AllowedContactTypes. 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 AllowedContactType 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 AllowedContactType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedLeadTypes/{id}:
    get:
      description: Returns AllowedLeadType with given id
      operationId: AllowedLeadTypes.get
      summary: AllowedLeadTypes.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedLeadType to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedLeadType 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/AllowedLeadType'
        '404':
          description: Sent when 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 AllowedLeadType with given id
      operationId: AllowedLeadTypes.delete
      summary: AllowedLeadTypes.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedLeadType to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadType on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedLeadType
                    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 AllowedLeadType or AllowedLeadTypes with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedLeadType to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadType on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedLeadTypes.update
      summary: AllowedLeadTypes.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedLeadTypeInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedLeadType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedLeadType'
        '404':
          description: Sent when 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/AllowedLeadTypes:
    get:
      description: Returns all defined AllowedLeadTypes
      operationId: AllowedLeadTypes.list
      summary: AllowedLeadTypes.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedLeadTypes 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 AllowedLeadTypes
          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/AllowedLeadType'
                  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 AllowedLeadType
      operationId: AllowedLeadTypes.create
      summary: AllowedLeadTypes.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadType on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedLeadType
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedLeadTypeInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedLeadType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedLeadType'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedLeadTypes/batch-delete:
    post:
      description: Removes AllowedLeadTypes with given list of ids
      operationId: AllowedLeadTypes.batch_delete
      summary: AllowedLeadTypes.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadTypes on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedLeadTypes. 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 AllowedLeadType 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 AllowedLeadType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedLeadTypes/batch-modify:
    post:
      description: Create or update an batch of AllowedLeadTypes
      operationId: AllowedLeadTypes.batch_create_or_update
      summary: AllowedLeadTypes.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadTypes on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedLeadType
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedLeadTypeInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedLeadTypes
          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/AllowedLeadTypes/batch-restore:
    post:
      description: Restores AllowedLeadTypes with given list of ids
      operationId: AllowedLeadTypes.batch_restore
      summary: AllowedLeadTypes.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedLeadTypes 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 AllowedLeadTypes. 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 AllowedLeadType 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 AllowedLeadType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedPipelines/{id}:
    get:
      description: Returns AllowedPipeline with given id
      operationId: AllowedPipelines.get
      summary: AllowedPipelines.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedPipeline to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedPipeline 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/AllowedPipeline'
        '404':
          description: Sent when 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 AllowedPipeline with given id
      operationId: AllowedPipelines.delete
      summary: AllowedPipelines.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedPipeline to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipeline on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedPipeline
                    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 AllowedPipeline or AllowedPipelines with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedPipeline to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipeline on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedPipelines.update
      summary: AllowedPipelines.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedPipelineInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedPipeline
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedPipeline'
        '404':
          description: Sent when 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/AllowedPipelines:
    get:
      description: Returns all defined AllowedPipelines
      operationId: AllowedPipelines.list
      summary: AllowedPipelines.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedPipelines 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 AllowedPipelines
          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/AllowedPipeline'
                  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 AllowedPipeline
      operationId: AllowedPipelines.create
      summary: AllowedPipelines.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipeline on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedPipeline
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedPipelineInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedPipeline
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedPipeline'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedPipelines/batch-delete:
    post:
      description: Removes AllowedPipelines with given list of ids
      operationId: AllowedPipelines.batch_delete
      summary: AllowedPipelines.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipelines on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedPipelines. 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 AllowedPipeline 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 AllowedPipeline.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedPipelines/batch-modify:
    post:
      description: Create or update an batch of AllowedPipelines
      operationId: AllowedPipelines.batch_create_or_update
      summary: AllowedPipelines.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipelines on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedPipeline
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedPipelineInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedPipelines
          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/AllowedPipelines/batch-restore:
    post:
      description: Restores AllowedPipelines with given list of ids
      operationId: AllowedPipelines.batch_restore
      summary: AllowedPipelines.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedPipelines 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 AllowedPipelines. 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 AllowedPipeline 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 AllowedPipeline.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedQuoteTypes/{id}:
    get:
      description: Returns AllowedQuoteType with given id
      operationId: AllowedQuoteTypes.get
      summary: AllowedQuoteTypes.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedQuoteType to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: AllowedQuoteType 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/AllowedQuoteType'
        '404':
          description: Sent when 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 AllowedQuoteType with given id
      operationId: AllowedQuoteTypes.delete
      summary: AllowedQuoteTypes.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of AllowedQuoteType to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteType on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 AllowedQuoteType
                    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 AllowedQuoteType or AllowedQuoteTypes with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of AllowedQuoteType to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteType on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: AllowedQuoteTypes.update
      summary: AllowedQuoteTypes.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAllowedQuoteTypeInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting AllowedQuoteType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedQuoteType'
        '404':
          description: Sent when 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/AllowedQuoteTypes:
    get:
      description: Returns all defined AllowedQuoteTypes
      operationId: AllowedQuoteTypes.list
      summary: AllowedQuoteTypes.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted AllowedQuoteTypes 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 AllowedQuoteTypes
          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/AllowedQuoteType'
                  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 AllowedQuoteType
      operationId: AllowedQuoteTypes.create
      summary: AllowedQuoteTypes.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteType on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedQuoteType
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createAllowedQuoteTypeInput'
      responses:
        '201':
          description: Creation confirmation. Returns created AllowedQuoteType
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/AllowedQuoteType'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedQuoteTypes/batch-delete:
    post:
      description: Removes AllowedQuoteTypes with given list of ids
      operationId: AllowedQuoteTypes.batch_delete
      summary: AllowedQuoteTypes.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteTypes on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedQuoteTypes. 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 AllowedQuoteType 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 AllowedQuoteType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/AllowedQuoteTypes/batch-modify:
    post:
      description: Create or update an batch of AllowedQuoteTypes
      operationId: AllowedQuoteTypes.batch_create_or_update
      summary: AllowedQuoteTypes.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteTypes on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new AllowedQuoteType
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchAllowedQuoteTypeInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated AllowedQuoteTypes
          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/AllowedQuoteTypes/batch-restore:
    post:
      description: Restores AllowedQuoteTypes with given list of ids
      operationId: AllowedQuoteTypes.batch_restore
      summary: AllowedQuoteTypes.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of AllowedQuoteTypes 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 AllowedQuoteTypes. 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 AllowedQuoteType 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 AllowedQuoteType.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/MasterRights/{id}:
    get:
      description: Returns MasterRight with given id
      operationId: MasterRights.get
      summary: MasterRights.get
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of MasterRight to retrieve
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: MasterRight 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/MasterRight'
        '404':
          description: Sent when 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 MasterRight with given id
      operationId: MasterRights.delete
      summary: MasterRights.delete
      tags:
      - MasterRight
      parameters:
      - name: id
        in: path
        description: ID of MasterRight to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRight on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        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 MasterRight
                    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 MasterRight or MasterRights with given id(s)
      parameters:
      - name: id
        in: path
        description: ID of MasterRight to update
        required: true
        schema:
          type: string
          format: uuid
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRight on update. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      operationId: MasterRights.update
      summary: MasterRights.update
      tags:
      - MasterRight
      requestBody:
        description: id(s) of modified item(s) and fields to modify
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateMasterRightInput'
      responses:
        '200':
          description: Modification confirmation. Returns resulting MasterRight
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/MasterRight'
        '404':
          description: Sent when 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/MasterRights:
    get:
      description: Returns all defined MasterRights
      operationId: MasterRights.list
      summary: MasterRights.list
      tags:
      - MasterRight
      parameters:
      - name: include-deleted
        in: query
        description: if enabled, deleted MasterRights 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 MasterRights
          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/MasterRight'
                  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 MasterRight
      operationId: MasterRights.create
      summary: MasterRights.create
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRight on create. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new MasterRight
        required: true
        content:
          application / json:
            schema:
              $ref: '#/components/schemas/createMasterRightInput'
      responses:
        '201':
          description: Creation confirmation. Returns created MasterRight
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: True when response succeeded, false on error.
                  data:
                    $ref: '#/components/schemas/MasterRight'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/MasterRights/batch-delete:
    post:
      description: Removes MasterRights with given list of ids
      operationId: MasterRights.batch_delete
      summary: MasterRights.batch_delete
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRights on delete. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for MasterRights. 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 MasterRight 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 MasterRight.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /entities/MasterRights/batch-modify:
    post:
      description: Create or update an batch of MasterRights
      operationId: MasterRights.batch_create_or_update
      summary: MasterRights.batch_create_or_update
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRights on change. Use them as bit mask: 0 - validate each field on entity,

          2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,

          16 - allows to set entity on deleted relationship.'
        schema:
          type: integer
          format: int32
      - name: rollback-method
        in: query
        description: Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records.
        schema:
          type: integer
          format: int32
      requestBody:
        description: data of new MasterRight
        required: true
        content:
          application / json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/batchMasterRightInput'
      responses:
        '200':
          description: Creation confirmation. Returns a list of created / updated MasterRights
          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/MasterRights/batch-restore:
    post:
      description: Restores MasterRights with given list of ids
      operationId: MasterRights.batch_restore
      summary: MasterRights.batch_restore
      tags:
      - MasterRight
      parameters:
      - name: validation-level
        in: query
        description: 'Specify validation level of MasterRights 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 MasterRights. 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 MasterRight 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 MasterRight.
                        format: uuid
                      - $ref: '#/components/schemas/Error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    createAllowedQuoteTypeInput:
      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
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        quote_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the quote type.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - master_right_id
      - quote_type_id
    batchAllowedCompanyPhoneInput:
      properties:
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        phone_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company phone.
        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
    batchAllowedAccountTypeInput:
      properties:
        account_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the account type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user 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
    createAllowedContactTypeInput:
      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_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the contact type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - contact_type_id
      - master_right_id
    AllowedLeadType:
      properties:
        is_delete_protected:
          type: boolean
          example: false
          description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
          readOnly: true
        id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Unique identifier of entity.
          readOnly: true
        is_deleted:
          type: boolean
          example: false
          description: Specifies if the entity is considered deleted.
          readOnly: true
        modified:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Last modification time.
          readOnly: true
        created:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Creation time.
          readOnly: true
        lead_type:
          type: string
          format: uri
          description: 'Lead type the user role can use.


            Relation to LeadType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''LeadType'' object for properties.'
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the lead type.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        lead_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the lead type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - lead_type
      - master_right
      - lead_type_id
      - master_right_id
    updateAllowedContactTypeInput:
      properties:
        contact_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the contact type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    Error:
      properties:
        http_status:
          description: HTTP status code
          type: integer
          example: 400
        code:
          description: Internal API error code
          type: integer
          example: 117
        name:
          description: Name of the API error
          type: string
          example: ERROR_PARAMETER_INVALID
        message:
          description: Description of the API error
          type: string
        success:
          description: Always false on error.
          type: boolean
          example: false
      required:
      - success
      - http_status
    createAllowedCompanyPhoneInput:
      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
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        phone_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company phone.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - master_right_id
      - phone_id
    AllowedCompanyEmail:
      properties:
        is_delete_protected:
          type: boolean
          example: false
          description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
          readOnly: true
        id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Unique identifier of entity.
          readOnly: true
        is_deleted:
          type: boolean
          example: false
          description: Specifies if the entity is considered deleted.
          readOnly: true
        modified:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Last modification time.
          readOnly: true
        created:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Creation time.
          readOnly: true
        company_email:
          type: string
          format: uri
          description: 'Company email address the user role can send from.


            Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CompanyEmail'' object for properties.'
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the company email address.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        company_email_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company email address.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - company_email
      - master_right
      - company_email_id
      - master_right_id
    updateAllowedAccountTypeInput:
      properties:
        account_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the account type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    updateMasterRightInput:
      properties:
        access_account_relation_types:
          type: boolean
          example: false
          description: Controls access to resource.
        access_accounts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_automatizer:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_detail:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_enrichment:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_relationship_charts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_reports:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_smart_field:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approvals:
          type: boolean
          example: false
          description: Controls access to resource.
        access_archive:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit_log:
          type: boolean
          example: false
          description: Controls access to resource.
        access_bulk_update:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_calling_purchase_phone:
          type: boolean
          example: false
          description: Controls access to resource.
        access_company_emails:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_contacts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_company:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_record:
          type: boolean
          example: false
          description: Controls access to resource.
        access_duplicate_checker:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_enforcement:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_settings:
          type: object
          description: Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
        access_entity_account:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_account_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_account_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_appointment:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_appointment_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_appointment_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_appointment_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_better_navigator_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_contact_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_contact_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_dashboard:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_dashboard_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_content_share_mode:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_entity_email_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_sequence:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_email_template:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_email_template_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_forecast_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_edit_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_form_view_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_lead_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_lead_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_message_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_oppty_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_oppty_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_pipeline:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
        access_entity_process:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_profile:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_profile_default_screen_profiles:
          type: object
          description: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
        access_entity_profile_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_project_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_project_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_quote_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_quote_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_report:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_report_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_target_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_task_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_task_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_unassigned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_export:
          type: boolean
          example: false
          description: Controls access to resource.
        access_feeds:
          type: boolean
          example: false
          description: Controls access to resource.
        access_foreign_currencies:
          type: boolean
          example: false
          description: Controls access to resource.
        access_form_and_fields:
          type: boolean
          example: false
          description: Controls access to resource.
        access_global_settings:
          type: boolean
          example: false
          description: Controls access to resource.
        access_home_screen:
          type: boolean
          example: false
          description: Controls access to resource.
        access_import:
          type: boolean
          example: false
          description: Controls access to resource.
        access_insights:
          type: boolean
          example: false
          description: Controls access to resource.
        access_leads:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_opportunity:
          type: boolean
          example: false
          description: Controls access to resource.
        access_pipeline_configuration:
          type: boolean
          example: false
          description: Controls access to resource.
        access_print:
          type: boolean
          example: false
          description: Controls access to resource.
        access_products_services:
          type: boolean
          example: false
          description: Controls access to resource.
        access_projects:
          type: boolean
          example: false
          description: Controls access to resource.
        access_quotes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_sales_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_security:
          type: boolean
          example: false
          description: Controls access to resource.
        access_units:
          type: boolean
          example: false
          description: Controls access to resource.
        access_user_and_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_whats_app_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        name:
          type: string
          example: string
          description: Name of the entity and its default text representation.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
        allowed_pipelines:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedPipeline, see: ''updateAllowedPipelineInput'' object for properties.'
          description: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted.
        allowed_lead_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedLeadType, see: ''updateAllowedLeadTypeInput'' object for properties.'
          description: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected.
        allowed_quote_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedQuoteType, see: ''updateAllowedQuoteTypeInput'' object for properties.'
          description: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected.
        allowed_account_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedAccountType, see: ''updateAllowedAccountTypeInput'' object for properties.'
          description: Account types this user role can use. Effective only when access_entity_account_types is set to Selected.
        allowed_contact_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedContactType, see: ''updateAllowedContactTypeInput'' object for properties.'
          description: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected.
        allowed_company_emails:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyEmail, see: ''updateAllowedCompanyEmailInput'' object for properties.'
          description: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected.
        allowed_company_phones:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyPhone, see: ''updateAllowedCompanyPhoneInput'' object for properties.'
          description: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected.
        custom_entities:
          type: string
          format: binary
          example: blob
          description: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space.
    updateAllowedLeadTypeInput:
      properties:
        lead_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the lead type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    AllowedCompanyPhone:
      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
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the company phone.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        phone:
          type: string
          format: uri
          description: 'Company phone the user role can use for calling/SMS.


            Relation to Phone. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Phone'' object for properties.'
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        phone_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company phone.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - master_right
      - phone
      - master_right_id
      - phone_id
    batchAllowedPipelineInput:
      properties:
        access_step_documents:
          type: boolean
          example: false
          description: When true, the user role can access documents attached to steps of this pipeline.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        pipeline_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the pipeline.
        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
    AllowedAccountType:
      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:
          type: string
          format: uri
          description: 'Account type the user role can use.


            Relation to AccountType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountType'' object for properties.'
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the account type.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        account_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the account type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - account_type
      - master_right
      - account_type_id
      - master_right_id
    AllowedPipeline:
      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
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the pipeline.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        pipeline:
          type: string
          format: uri
          description: 'Pipeline the user role can use.


            Relation to Pipeline. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Pipeline'' object for properties.'
        access_step_documents:
          type: boolean
          example: false
          description: When true, the user role can access documents attached to steps of this pipeline.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        pipeline_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the pipeline.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - master_right
      - pipeline
      - master_right_id
      - pipeline_id
    AllowedQuoteType:
      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
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the quote type.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        quote_type:
          type: string
          format: uri
          description: 'Quote type the user role can use.


            Relation to QuoteType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteType'' object for properties.'
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        quote_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the quote type.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - master_right
      - quote_type
      - master_right_id
      - quote_type_id
    updateAllowedCompanyPhoneInput:
      properties:
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        phone_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company phone.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    createAllowedCompanyEmailInput:
      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
        company_email_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company email address.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - company_email_id
      - master_right_id
    updateAllowedQuoteTypeInput:
      properties:
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        quote_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the quote type.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    updateAllowedPipelineInput:
      properties:
        access_step_documents:
          type: boolean
          example: false
          description: When true, the user role can access documents attached to steps of this pipeline.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        pipeline_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the pipeline.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    createMasterRightInput:
      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
        access_account_relation_types:
          type: boolean
          example: false
          description: Controls access to resource.
        access_accounts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_automatizer:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_detail:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_enrichment:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_relationship_charts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_reports:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_smart_field:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approvals:
          type: boolean
          example: false
          description: Controls access to resource.
        access_archive:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit_log:
          type: boolean
          example: false
          description: Controls access to resource.
        access_bulk_update:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_calling_purchase_phone:
          type: boolean
          example: false
          description: Controls access to resource.
        access_company_emails:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_contacts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_company:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_record:
          type: boolean
          example: false
          description: Controls access to resource.
        access_duplicate_checker:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_enforcement:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_settings:
          type: object
          description: Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
        access_entity_account:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_account_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_account_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_appointment:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_appointment_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_appointment_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_appointment_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_better_navigator_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_contact_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_contact_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_dashboard:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_dashboard_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_content_share_mode:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_entity_email_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_sequence:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_email_template:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_email_template_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_forecast_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_edit_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_form_view_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_lead_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_lead_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_message_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_oppty_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_oppty_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_pipeline:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
        access_entity_process:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_profile:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_profile_default_screen_profiles:
          type: object
          description: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
        access_entity_profile_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_project_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_project_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_quote_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_quote_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_report:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_report_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_target_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_task_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_task_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_unassigned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_export:
          type: boolean
          example: false
          description: Controls access to resource.
        access_feeds:
          type: boolean
          example: false
          description: Controls access to resource.
        access_foreign_currencies:
          type: boolean
          example: false
          description: Controls access to resource.
        access_form_and_fields:
          type: boolean
          example: false
          description: Controls access to resource.
        access_global_settings:
          type: boolean
          example: false
          description: Controls access to resource.
        access_home_screen:
          type: boolean
          example: false
          description: Controls access to resource.
        access_import:
          type: boolean
          example: false
          description: Controls access to resource.
        access_insights:
          type: boolean
          example: false
          description: Controls access to resource.
        access_leads:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_opportunity:
          type: boolean
          example: false
          description: Controls access to resource.
        access_pipeline_configuration:
          type: boolean
          example: false
          description: Controls access to resource.
        access_print:
          type: boolean
          example: false
          description: Controls access to resource.
        access_products_services:
          type: boolean
          example: false
          description: Controls access to resource.
        access_projects:
          type: boolean
          example: false
          description: Controls access to resource.
        access_quotes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_sales_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_security:
          type: boolean
          example: false
          description: Controls access to resource.
        access_units:
          type: boolean
          example: false
          description: Controls access to resource.
        access_user_and_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_whats_app_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        name:
          type: string
          example: string
          description: Name of the entity and its default text representation.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
        allowed_pipelines:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedPipeline, see: ''createAllowedPipelineInput'' object for properties.'
          description: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted.
        allowed_lead_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedLeadType, see: ''createAllowedLeadTypeInput'' object for properties.'
          description: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected.
        allowed_quote_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedQuoteType, see: ''createAllowedQuoteTypeInput'' object for properties.'
          description: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected.
        allowed_account_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedAccountType, see: ''createAllowedAccountTypeInput'' object for properties.'
          description: Account types this user role can use. Effective only when access_entity_account_types is set to Selected.
        allowed_contact_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedContactType, see: ''createAllowedContactTypeInput'' object for properties.'
          description: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected.
        allowed_company_emails:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyEmail, see: ''createAllowedCompanyEmailInput'' object for properties.'
          description: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected.
        allowed_company_phones:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyPhone, see: ''createAllowedCompanyPhoneInput'' object for properties.'
          description: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected.
        custom_entities:
          type: string
          format: binary
          example: blob
          description: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space.
      required:
      - name
    createAllowedAccountTypeInput:
      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_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the account type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - account_type_id
      - master_right_id
    createAllowedPipelineInput:
      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
        access_step_documents:
          type: boolean
          example: false
          description: When true, the user role can access documents attached to steps of this pipeline.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        pipeline_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the pipeline.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - master_right_id
      - pipeline_id
    MasterRight:
      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
        access_account_relation_types:
          type: boolean
          example: false
          description: Controls access to resource.
        access_accounts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_automatizer:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_detail:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_enrichment:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_relationship_charts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_reports:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_smart_field:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approvals:
          type: boolean
          example: false
          description: Controls access to resource.
        access_archive:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit_log:
          type: boolean
          example: false
          description: Controls access to resource.
        access_bulk_update:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_calling_purchase_phone:
          type: boolean
          example: false
          description: Controls access to resource.
        access_company_emails:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_contacts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_company:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_record:
          type: boolean
          example: false
          description: Controls access to resource.
        access_duplicate_checker:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_enforcement:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_settings:
          type: object
          description: Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
        access_entity_account:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_account_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_account_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_appointment:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_appointment_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_appointment_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_appointment_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_better_navigator_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_contact_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_contact_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_dashboard:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_dashboard_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_content_share_mode:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_entity_email_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_sequence:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_email_template:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_email_template_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_forecast_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_edit_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_form_view_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_lead_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_lead_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_message_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_oppty_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_oppty_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_pipeline:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
        access_entity_process:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_profile:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_profile_default_screen_profiles:
          type: object
          description: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
        access_entity_profile_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_project_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_project_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_quote_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_quote_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_report:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_report_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_target_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_task_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_task_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_unassigned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_export:
          type: boolean
          example: false
          description: Controls access to resource.
        access_feeds:
          type: boolean
          example: false
          description: Controls access to resource.
        access_foreign_currencies:
          type: boolean
          example: false
          description: Controls access to resource.
        access_form_and_fields:
          type: boolean
          example: false
          description: Controls access to resource.
        access_global_settings:
          type: boolean
          example: false
          description: Controls access to resource.
        access_home_screen:
          type: boolean
          example: false
          description: Controls access to resource.
        access_import:
          type: boolean
          example: false
          description: Controls access to resource.
        access_insights:
          type: boolean
          example: false
          description: Controls access to resource.
        access_leads:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_opportunity:
          type: boolean
          example: false
          description: Controls access to resource.
        access_pipeline_configuration:
          type: boolean
          example: false
          description: Controls access to resource.
        access_print:
          type: boolean
          example: false
          description: Controls access to resource.
        access_products_services:
          type: boolean
          example: false
          description: Controls access to resource.
        access_projects:
          type: boolean
          example: false
          description: Controls access to resource.
        access_quotes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_sales_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_security:
          type: boolean
          example: false
          description: Controls access to resource.
        access_units:
          type: boolean
          example: false
          description: Controls access to resource.
        access_user_and_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_whats_app_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        name:
          type: string
          example: string
          description: Name of the entity and its default text representation.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
        allowed_pipelines:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedPipeline. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedPipeline'' object for properties.'
          description: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted.
        allowed_lead_types:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedLeadType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedLeadType'' object for properties.'
          description: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected.
        allowed_quote_types:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedQuoteType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedQuoteType'' object for properties.'
          description: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected.
        allowed_account_types:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedAccountType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedAccountType'' object for properties.'
          description: Account types this user role can use. Effective only when access_entity_account_types is set to Selected.
        allowed_contact_types:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedContactType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedContactType'' object for properties.'
          description: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected.
        allowed_company_emails:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedCompanyEmail. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedCompanyEmail'' object for properties.'
          description: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected.
        allowed_company_phones:
          type: array
          items:
            type: string
            format: uri
            description: 'Relation to AllowedCompanyPhone. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AllowedCompanyPhone'' object for properties.'
          description: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected.
        custom_entities:
          type: string
          format: binary
          example: blob
          description: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space.
      required:
      - is_delete_protected
      - id
      - name
    batchAllowedContactTypeInput:
      properties:
        contact_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the contact type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user 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
    batchAllowedLeadTypeInput:
      properties:
        lead_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the lead type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user 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
    updateAllowedCompanyEmailInput:
      properties:
        company_email_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company email address.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
    batchMasterRightInput:
      properties:
        access_account_relation_types:
          type: boolean
          example: false
          description: Controls access to resource.
        access_accounts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_automatizer:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_detail:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_record_enrichment:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_relationship_charts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_reports:
          type: boolean
          example: false
          description: Controls access to resource.
        access_ai_smart_field:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler:
          type: boolean
          example: false
          description: Controls access to resource.
        access_appointment_scheduler_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approval_processes_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_approvals:
          type: boolean
          example: false
          description: Controls access to resource.
        access_archive:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit:
          type: boolean
          example: false
          description: Controls access to resource.
        access_audit_log:
          type: boolean
          example: false
          description: Controls access to resource.
        access_bulk_update:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling:
          type: boolean
          example: false
          description: Controls access to resource.
        access_calling_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_calling_purchase_phone:
          type: boolean
          example: false
          description: Controls access to resource.
        access_company_emails:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_contacts:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_company:
          type: boolean
          example: false
          description: Controls access to resource.
        access_document_management_record:
          type: boolean
          example: false
          description: Controls access to resource.
        access_duplicate_checker:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_enforcement:
          type: boolean
          example: false
          description: Controls access to resource.
        access_email_notification_settings:
          type: object
          description: Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
        access_entity_account:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_account_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_account_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_account_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_appointment:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_appointment_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_appointment_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_appointment_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_better_navigator_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_better_navigator_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_contact_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_contact_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_contact_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_dashboard:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_dashboard_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_dashboard_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_content_share_mode:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly'
          example: 0
          enum:
          - 0
          - 1
          - 2
        access_entity_email_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_sequence:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_email_template:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_email_template_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_email_template_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_forecast_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_edit_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_forecast_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_form_view_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_form_view_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_lead_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_lead_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_lead_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_message_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_oppty_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_oppty_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_oppty_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_pipeline:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
        access_entity_process:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess'
          example: 1
          enum:
          - 1
          - 2
          - 3
        access_entity_profile:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_profile_default_screen_profiles:
          type: object
          description: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
        access_entity_profile_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_profile_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_project_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_project_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_project_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_quote_copy:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_quote_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_quote_types:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - All, 2 - Selected'
          example: 1
          enum:
          - 1
          - 2
        access_entity_report:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_report_create_delete_folder:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_private:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_schedule_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_custom:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_report_sharing_public:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 4
        access_entity_target_delete_not_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_target_delete_owned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        access_entity_task_delete:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_direction:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All'
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        access_entity_task_tag_create:
          type: boolean
          example: false
          description: Controls access to resource.
        access_entity_task_unassigned:
          type: boolean
          example: false
          description: Controls access to resource.
        access_export:
          type: boolean
          example: false
          description: Controls access to resource.
        access_feeds:
          type: boolean
          example: false
          description: Controls access to resource.
        access_foreign_currencies:
          type: boolean
          example: false
          description: Controls access to resource.
        access_form_and_fields:
          type: boolean
          example: false
          description: Controls access to resource.
        access_global_settings:
          type: boolean
          example: false
          description: Controls access to resource.
        access_home_screen:
          type: boolean
          example: false
          description: Controls access to resource.
        access_import:
          type: boolean
          example: false
          description: Controls access to resource.
        access_insights:
          type: boolean
          example: false
          description: Controls access to resource.
        access_leads:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms:
          type: boolean
          example: false
          description: Controls access to resource.
        access_online_forms_management:
          type: boolean
          example: false
          description: Controls access to resource.
        access_opportunity:
          type: boolean
          example: false
          description: Controls access to resource.
        access_pipeline_configuration:
          type: boolean
          example: false
          description: Controls access to resource.
        access_print:
          type: boolean
          example: false
          description: Controls access to resource.
        access_products_services:
          type: boolean
          example: false
          description: Controls access to resource.
        access_projects:
          type: boolean
          example: false
          description: Controls access to resource.
        access_quotes:
          type: boolean
          example: false
          description: Controls access to resource.
        access_sales_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_security:
          type: boolean
          example: false
          description: Controls access to resource.
        access_units:
          type: boolean
          example: false
          description: Controls access to resource.
        access_user_and_roles:
          type: boolean
          example: false
          description: Controls access to resource.
        access_whats_app_company_phone:
          type: integer
          description: 'Field whose values are strictly defined with an enumeration of values.


            Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All'
          example: 0
          enum:
          - 0
          - 1
          - 2
        name:
          type: string
          example: string
          description: Name of the entity and its default text representation.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
        allowed_pipelines:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedPipeline, see: ''updateAllowedPipelineInput'' object for properties.'
          description: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted.
        allowed_lead_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedLeadType, see: ''updateAllowedLeadTypeInput'' object for properties.'
          description: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected.
        allowed_quote_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedQuoteType, see: ''updateAllowedQuoteTypeInput'' object for properties.'
          description: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected.
        allowed_account_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedAccountType, see: ''updateAllowedAccountTypeInput'' object for properties.'
          description: Account types this user role can use. Effective only when access_entity_account_types is set to Selected.
        allowed_contact_types:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedContactType, see: ''updateAllowedContactTypeInput'' object for properties.'
          description: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected.
        allowed_company_emails:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyEmail, see: ''updateAllowedCompanyEmailInput'' object for properties.'
          description: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected.
        allowed_company_phones:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uri
            description: 'Relation to AllowedCompanyPhone, see: ''updateAllowedCompanyPhoneInput'' object for properties.'
          description: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected.
        custom_entities:
          type: string
          format: binary
          example: blob
          description: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space.
        id:
          description: ID of object to update.
          type: string
          format: uuid
    batchAllowedQuoteTypeInput:
      properties:
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        quote_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the quote 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
    createAllowedLeadTypeInput:
      properties:
        modified:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Last modification time.
          readOnly: true
        created:
          type: string
          format: date-time
          example: '2019-01-01T00:00:00'
          description: Creation time.
          readOnly: true
        lead_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the lead type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - lead_type_id
      - master_right_id
    batchAllowedCompanyEmailInput:
      properties:
        company_email_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the company email address.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user 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
    AllowedContactType:
      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:
          type: string
          format: uri
          description: 'Contact type the user role can use.


            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.'
        master_right:
          type: string
          format: uri
          description: 'User role granted access to the contact type.


            Relation to MasterRight. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MasterRight'' object for properties.'
        contact_type_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the contact type.
        master_right_id:
          type: string
          format: uuid
          example: 01234567-abcd-dcba-ffff-000000000000
          description: Id of the user role.
        revision:
          type: integer
          format: int32
          example: 1
          description: Revision when entity was lastly changed.
      required:
      - is_delete_protected
      - id
      - contact_type
      - master_right
      - contact_type_id
      - master_right_id