github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/api/openapi.yaml

openapi: 3.0.0
info:
  termsOfService: https://developer.ringcentral.com
  title: Engage Digital API
  version: "1.0"
servers:
- url: https://DOMAIN.api.engagement.dimelo.com/1.0
tags:
- name: Agent Status
paths:
  /attachments:
    get:
      description: This method renders attachments ordered by creation date (descending).
      operationId: getAllAttachments
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllAttachmentsResponse'
          description: Success
      summary: Getting all attachments
      tags:
      - Attachments
    post:
      description: This method allows you to create an new attachment.
      operationId: createAttachment
      requestBody:
        content:
          'multipart/form-data:':
            schema:
              properties:
                file:
                  format: binary
                  type: string
                private:
                  enum:
                  - "true"
                  - =1
                  type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: Success
        422:
          description: Compose is not supported on this source (compose_disabled_on_source)
      summary: Creating an attachment
      tags:
      - Attachments
  /attachments/{attachmentId}:
    get:
      description: This method renders an attachment from given id.
      operationId: getAttachment
      parameters:
      - explode: false
        in: path
        name: attachmentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: Success
      summary: Getting an attachment from its id
      tags:
      - Attachments
  /categories:
    get:
      description: This method renders categories ordered by creation date (ascending).
      operationId: getAllCategories
      parameters:
      - description: To filter categories on given category parent id.
        explode: true
        in: query
        name: parent_id
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCategoriesResponse'
          description: Success
      summary: Getting all categories
      tags:
      - Categories
    post:
      description: |-
        This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

        Note: The fields ​`mandatory`,​ `​multiple`,​ ​`post_qualification​`, `s​ource_ids`​ and `u​nselectable​` are accounted for only if the Category has no parent.

        Authorization​: only users that can manage teams.
      operationId: createCategory
      parameters:
      - description: Category name.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: ID of parent category.
        explode: true
        in: query
        name: parent_id
        required: false
        schema:
          type: string
        style: form
      - description: 'displayed color for the category, see Category colors. '
        explode: true
        in: query
        name: color
        required: false
        schema:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          type: integer
        style: form
      - description: mandatory categorization (Boolean).
        explode: true
        in: query
        name: mandatory
        required: false
        schema:
          type: boolean
        style: form
      - description: allow to assign multiple child categories (Boolean).
        explode: true
        in: query
        name: multiple
        required: false
        schema:
          type: boolean
        style: form
      - description: post qualification (Boolean).
        explode: true
        in: query
        name: post_qualification
        required: false
        schema:
          type: boolean
        style: form
      - description: root category is unselectable (Boolean).
        explode: true
        in: query
        name: unselectable
        required: false
        schema:
          type: boolean
        style: form
      - description: List of source id.
        explode: true
        in: query
        name: source_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: Success
      summary: Creating a category
      tags:
      - Categories
  /categories/{categoryId}:
    delete:
      description: This method destroys an existing category. It renders the category
        itself. It renders a 404 if id is invalid.
      operationId: deleteCategory
      parameters:
      - explode: false
        in: path
        name: categoryId
        required: true
        schema:
          type: string
        style: simple
      - description: ID of a category to recategorize (optional).
        explode: true
        in: query
        name: take_over_category_id
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: Success
      summary: Deleting a category
      tags:
      - Categories
    get:
      description: This method renders a category from given id.
      operationId: getCategory
      parameters:
      - explode: false
        in: path
        name: categoryId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: Success
      summary: Getting a category from its id
      tags:
      - Categories
    put:
      description: |-
        This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

        Note: The fields ​`mandatory`,​ ​`multiple`,​ ​`post_qualification​`, `s​ource_ids​` and `u​nselectable​` are accounted for only if the Category has no parent.

        Authorization​: only users that can manage teams.
      operationId: updateCategory
      parameters:
      - explode: false
        in: path
        name: categoryId
        required: true
        schema:
          type: string
        style: simple
      - description: Category name.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: ID of parent category.
        explode: true
        in: query
        name: parent_id
        required: false
        schema:
          type: string
        style: form
      - description: 'displayed color for the category, see Category colors. '
        explode: true
        in: query
        name: color
        required: false
        schema:
          type: integer
        style: form
      - description: mandatory categorization (Boolean).
        explode: true
        in: query
        name: mandatory
        required: false
        schema:
          type: boolean
        style: form
      - description: allow to assign multiple child categories (Boolean).
        explode: true
        in: query
        name: multiple
        required: false
        schema:
          type: boolean
        style: form
      - description: post qualification (Boolean).
        explode: true
        in: query
        name: post_qualification
        required: false
        schema:
          type: boolean
        style: form
      - description: root category is unselectable (Boolean).
        explode: true
        in: query
        name: unselectable
        required: false
        schema:
          type: boolean
        style: form
      - description: List of source id.
        explode: true
        in: query
        name: source_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: Success
      summary: Updating a category
      tags:
      - Categories
  /channels:
    get:
      description: This method renders all channels ordered by date of creation.
      operationId: getAllChannels
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllChannelsResponse'
          description: Success
      summary: Getting all channels
      tags:
      - Channels
  /channels/{channelId}:
    get:
      description: This method renders a channel from given id.
      operationId: getChannel
      parameters:
      - explode: false
        in: path
        name: channelId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
          description: Success
      summary: Getting a channel from its id
      tags:
      - Channels
    put:
      description: |-
        This method updates an existing channel from given attributes and renders it in case of success.

        Authorization​: only users that are able to update channels.
      operationId: updateChannel
      parameters:
      - explode: false
        in: path
        name: channelId
        required: true
        schema:
          type: string
        style: simple
      - description: The name of the channel.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: An array containing id of each source assigned to a channel (multiple).
        explode: true
        in: query
        name: source_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Number of tasks that can be assigned to agent by the routing
          before they are considered "occupied".
        explode: true
        in: query
        name: soft_capability
        required: false
        schema:
          type: integer
        style: form
      - description: M​aximum number of tasks that can be assigned to agents.
        explode: true
        in: query
        name: hard_capability
        required: false
        schema:
          type: integer
        style: form
      - description: this field defines the time before a task expires (in seconds).
        explode: true
        in: query
        name: task_timeout_seconds
        required: false
        schema:
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
          description: Success
      summary: Updating a channel
      tags:
      - Channels
  /communities:
    get:
      description: This method renders communities ordered by creation date (ascending).
      operationId: getAllCommunities
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCommunitiesResponse'
          description: Success
      summary: Getting all communities
      tags:
      - Communities
  /communities/{communityId}:
    get:
      description: This method renders a community from given id.
      operationId: getCommunity
      parameters:
      - explode: false
        in: path
        name: communityId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Community'
          description: Success
      summary: Getting a community from its id
      tags:
      - Communities
  /content_sources:
    get:
      description: This method renders sources ordered by creation date (ascending).
      operationId: getAllSources
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllSourcesResponse'
          description: Success
      summary: Getting all sources
      tags:
      - Sources
  /content_sources/{sourceId}:
    get:
      description: This method renders a source from given id.
      operationId: getSource
      parameters:
      - explode: false
        in: path
        name: sourceId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Source'
          description: Success
      summary: Getting a source from its id
      tags:
      - Sources
    put:
      description: This method updates an existing source from given attributes and
        renders it in case of success.
      operationId: updateSource
      parameters:
      - explode: false
        in: path
        name: sourceId
        required: true
        schema:
          type: string
        style: simple
      - description: Source name
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: Activate/deactivate the source (Boolean)
        explode: true
        in: query
        name: active
        required: false
        schema:
          type: boolean
        style: form
      - description: Channel
        explode: true
        in: query
        name: channel_id
        required: false
        schema:
          type: string
        style: form
      - description: Color of the icon (see S​ ource colors​) (Integer)
        explode: true
        in: query
        name: color
        required: false
        schema:
          type: integer
        style: form
      - description: Response time (seconds)
        explode: true
        in: query
        name: sla_response
        required: false
        schema:
          type: integer
        style: form
      - description: SLA expired strategy ("max", "half" or "base")
        explode: true
        in: query
        name: sla_expired_strategy
        required: false
        schema:
          enum:
          - max
          - half
          - base
          type: string
        style: form
      - description: Priority boost of messages with intervention (Integer)
        explode: true
        in: query
        name: intervention_messages_boost
        required: false
        schema:
          type: integer
        style: form
      - description: Priority boost of transferred tasks (Integer)
        explode: true
        in: query
        name: transferred_tasks_boost
        required: false
        schema:
          type: integer
        style: form
      - description: Hide from statistics (Boolean)
        explode: true
        in: query
        name: hidden_from_stats
        required: false
        schema:
          type: boolean
        style: form
      - description: Default categories
        explode: true
        in: query
        name: default_category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Default categories (agent messages)
        explode: true
        in: query
        name: user_thread_default_category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Default content language
        explode: true
        in: query
        name: default_content_language
        required: false
        schema:
          type: string
        style: form
      - description: Auto-detect content language (Boolean)
        explode: true
        in: query
        name: auto_detect_content_language
        required: false
        schema:
          type: boolean
        style: form
      - description: Automatic archiving of old contents (Boolean)
        explode: true
        in: query
        name: content_archiving
        required: false
        schema:
          type: boolean
        style: form
      - description: Archive contents older than (seconds)
        explode: true
        in: query
        name: content_archiving_period
        required: false
        schema:
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Source'
          description: Success
      summary: Updating a source
      tags:
      - Sources
  /content_threads:
    get:
      description: |-
        This method renders threads ordered by last content date (descending). Only threads in sources where token’s user has “read” permission are returned.

        Authorization​: no.
      operationId: getAllThreads
      parameters:
      - description: A search query to filter threads. Please refer to ​Search & filtering
          parameters​ for more details.
        explode: true
        in: query
        name: q
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllThreadsResponse'
          description: Success
      summary: Getting all threads
      tags:
      - Threads
  /content_threads/{threadId}:
    get:
      description: |-
        This method renders a thread from given id. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: getThread
      parameters:
      - explode: false
        in: path
        name: threadId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
          description: Success
      summary: Getting a thread from its id
      tags:
      - Threads
  /content_threads/{threadId}/close:
    put:
      description: |-
        Thread closure/opening is only available for the following sources:
        * Emails
        * Answers
        * Ideas
        * Facebook Messenger
        * Google+
        * Lithium
        * Mobile Messaging

        Starts a job to close a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object do not is the one when the job started.

        If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be closed or if the user does not have the permission to close a thread.

        Authorization​: no.
      operationId: closeThread
      parameters:
      - explode: false
        in: path
        name: threadId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
          description: Success
      summary: Close a thread
      tags:
      - Threads
  /content_threads/{threadId}/ignore:
    put:
      description: |-
        Archives the contents of a thread. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.

        If the thread is already being archived, a 409 HTTP response will be returned.

        Authorization​: no.
      operationId: archiveThread
      parameters:
      - explode: false
        in: path
        name: threadId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
          description: Success
      summary: Archiving a thread
      tags:
      - Threads
  /content_threads/{threadId}/open:
    get:
      description: |-
        Thread closure/opening is only available for the following sources:

        * Emails
        * Answers
        * Ideas
        * Facebook Messenger
        * Google+
        * Lithium
        * Mobile Messaging

        Starts a job to open a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object is the one when the job started.

        If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be opened or if the user does not have the permission to open a thread.

        Authorization​: no.
      operationId: openThread
      parameters:
      - explode: false
        in: path
        name: threadId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
          description: Success
      summary: Open a thread
      tags:
      - Threads
  /content_threads/{threadId}/update_categories:
    put:
      description: |-
        This method updates the categories of a thread. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.

        If the thread is already being categorized, a 409 HTTP response will be returned.

        Authorization​: no.
      operationId: categorizeThread
      parameters:
      - explode: false
        in: path
        name: threadId
        required: true
        schema:
          type: string
        style: simple
      - description: An array containing the new categories to set on the thread.
        explode: true
        in: query
        name: thread_category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
          description: Success
      summary: Categorizing a thread
      tags:
      - Threads
  /contents:
    get:
      description: |-
        This method renders contents ordered by creation date (descending). Only contents in sources where token’s user has “read” permission are returned.

        Authorization​: no.
      operationId: getAllContents
      parameters:
      - description: 'To filter contents on given query. Query works exactly like
          threads query but only have those keywords: intervention,identity, identity_group,
          source, status_in, thread or text. Order can be created_at.desc (default)
          or created_at.asc. e.g. q=intervention:"7f946431b6eebffafae642cc"%20source:"d19c81948c137d86dac77216"
          Please refer to ​Search & filtering parameters​ for more details.'
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllContentsResponse'
          description: Success
      summary: Contents
      tags:
      - Contents
    post:
      description: |-
        This method allows you to create an new content. It can be a reply to another content or a content that initiate discussion. It use token’s user as content user if he is authorized. Content will be created in Dimelo Digital and pushed asynchronously to the source.

        Replying to a customer content is usually possible (unless the source/conversation is read only).

        Composing a content on the contrary depend on the source itself:
        * The source may not support it (and be purely reactive like Instagram, Messenger ...)
        * Some sources (usually public account) like Twitter or Facebook page allows to publish content without targeting specific individuals.
        * Some sources (usually non public media) require specific targeting (phone number for SMS, email address for email, customer_id ...) to be able to create a content. This is source specific and detailed under the generic parameters.

        Authorization​: only users that can reply or initiate discussion (= compose) on given source. it renders also an error if in_reply_to isn’t synchronized or if in_reply_to content is not under an ​open intervention.
      operationId: createContent
      parameters:
      - description: The identity id of content. This parameter is not mandatory,
          by default it use the token’s user first identity on source.
        explode: true
        in: query
        name: author_id
        required: false
        schema:
          type: string
        style: form
      - description: The content’s body. This parameter is mandatory.
        explode: true
        in: query
        name: body
        required: true
        schema:
          type: string
        style: form
      - description: The content’s id you want to reply to. If omitted, a new discussion
          will be created. If source does not support to initiate discussion this
          parameter is mandatory.
        explode: true
        in: query
        name: in_reply_to_id
        required: false
        schema:
          type: string
        style: form
      - description: Created contents are public by default, set this parameter to
          "1" in order to create a private reply. It is NOT supported on every source.
        explode: true
        in: query
        name: private
        required: false
        schema:
          type: integer
        style: form
      - description: The source to create content to. If you specify `in_reply_to_id`
          parameter, source will be determined from it. Otherwise, this parameter
          is mandatory.
        explode: true
        in: query
        name: source_id
        required: false
        schema:
          type: string
        style: form
      - description: An array containing the attachments’ ids that need to be attached
          to this content.
        explode: true
        in: query
        name: attachment_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: For an email source. The subject of the email. This parameter
          is mandatory when initiating a discussion.
        explode: true
        in: query
        name: title
        required: false
        schema:
          type: string
        style: form
      - description: 'For an email or SMS source. For an email, an array containing
          the email addresses used in the “To” section of the email. This parameter
          is mandatory when initiating a discussion. For a SMS, the number the SMS
          will be sent to. It must start with 00 or +, example: +33634231224 or 0033634231224.
          This parameter is mandatory when initiating a discussion.'
        explode: true
        in: query
        name: to[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: For an email source. An array containing the email addresses
          used in the “Cc” section of the email.
        explode: true
        in: query
        name: cc[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: For an email source. An array containing the email addresses
          used in the “Bcc” section of the email.
        explode: true
        in: query
        name: bcc[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
          description: Success
        422:
          description: Unprocessable Entity
      summary: Creating a content
      tags:
      - Contents
  /contents/{contentId}:
    get:
      description: |-
        This method renders a content from given id. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: getContent
      parameters:
      - explode: false
        in: path
        name: contentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
          description: Success
      summary: Getting a content from its id
      tags:
      - Contents
  /contents/{contentId}/ignore:
    put:
      description: |-
        Ignores a content. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: ignoreContent
      parameters:
      - explode: false
        in: path
        name: contentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
          description: Success
        404:
          description: Not Found
      summary: Ignoring a content
      tags:
      - Contents
  /contents/{contentId}/update_categories:
    put:
      description: |-
        This method updates the categories of a content. If token’s user does not have “read” on this content’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: categorizeContent
      parameters:
      - explode: false
        in: path
        name: contentId
        required: true
        schema:
          type: string
        style: simple
      - description: An array containing the new categories to set on the content.
        explode: true
        in: query
        name: category_ids[]
        required: true
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
          description: Success
      summary: Categorizing a content
      tags:
      - Contents
  /custom_fields:
    get:
      description: |-
        This method renders custom fields ordered by position (ascending).

        Authorization​: only users that can see custom fields in administration section.
      operationId: getAllCustomFields
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCustomFieldsResponse'
          description: Success
      summary: Getting all custom fields
      tags:
      - CustomFields
    post:
      description: |-
        This method creates a custom field. In case of success it renders the custom field, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that can create custom fields.
      operationId: createCustomField
      parameters:
      - description: The associated type of custom field. It can be IdentityGroup
          or Intervention.
        explode: true
        in: query
        name: associated_type_name
        required: true
        schema:
          enum:
          - IdentityGroup
          - Intervention
          type: string
        style: form
      - description: The label of the custom field.
        explode: true
        in: query
        name: label
        required: true
        schema:
          type: string
        style: form
      - description: 'The key of the custom field (example: customer_id). This is
          used to determine how it is stored on identity groups.'
        explode: true
        in: query
        name: key
        required: false
        schema:
          type: string
        style: form
      - description: The type of the custom field. It can be string, boolean, text,
          integer, float, single_choice,
        explode: true
        in: query
        name: type
        required: false
        schema:
          enum:
          - string
          - boolean
          - text
          - integer
          - float
          - single_choice
          - multiple_choice
          type: string
        style: form
      - description: A list of choices to be for single_choice, or multiple_choice
          types. This must be given
        explode: true
        in: query
        name: choices
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: true or false, this as no effect on single_choice, multiple_choice
          or boolean types
        explode: true
        in: query
        name: multiple
        required: false
        schema:
          type: boolean
        style: form
      - description: 'an integer that indicates custom field’s position between others
          (default: -1).'
        explode: true
        in: query
        name: position
        required: false
        schema:
          default: -1
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: Success
      summary: Creating a custom field
      tags:
      - CustomFields
  /custom_fields/{customFieldId}:
    delete:
      description: |-
        This method destroys an existing custom field. It renders custom field itself. It renders a 404 if id is invalid.

        Authorization​: only users that are able to destroy custom fields..
      operationId: deleteCustomField
      parameters:
      - explode: false
        in: path
        name: customFieldId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: Success
      summary: Deleting a custom field
      tags:
      - CustomFields
    get:
      description: |-
        This method renders a custom field from given id.

        Authorization​: only users that can see custom fields in administration section.
      operationId: getCustomField
      parameters:
      - explode: false
        in: path
        name: customFieldId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: Success
      summary: Getting a custom field from its id
      tags:
      - CustomFields
    put:
      description: |-
        This method updates an existing custom field from given attributes and renders it in case of success.

        Authorization​: only users that are able to update custom fields.
      operationId: updateCustomField
      parameters:
      - explode: false
        in: path
        name: customFieldId
        required: true
        schema:
          type: string
        style: simple
      - description: Custom field’s label.
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - explode: true
        in: query
        name: choices
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Custom field’s position.
        explode: true
        in: query
        name: position
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: Success
      summary: Updating a custom field
      tags:
      - CustomFields
  /events:
    get:
      description: |-
        This method renders events ordered by creation date (descending).

        Authorization​: Only users whose role can search event permission.
      operationId: getAllEvents
      parameters:
      - description: |-
          To filter events on given query. Query works exactly like threads query but only have those keywords: content, content_thread, name_in, created_before, created_after, user. Order can be created_at.desc (default) or created_at.asc. e.g. q=name_in:"content.replied"%20content_thread:"7f946431b6eebffafae642cc"%20created_after:"2014-03-20"%20user:"4ee91f197aa58d01b500000f"%20order:"created_at.asc"
          * DateTime parameters should be ISO-8601
          * you can specify multiple value for a given keyword: q=name_in:’content.replied’&name_in:’content.ignored’
          Please refer to ​Search & filtering parameters​ for more details.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllEventsResponse'
          description: Success
      summary: Getting all events
      tags:
      - Events
  /events/{eventId}:
    get:
      description: |-
        This method renders an event from given id. If token’s user role does not have “search event” permission a 404 HTTP response will be returned.

        Authorization​: Only users who’s role can search event permission.
      operationId: getEvent
      parameters:
      - explode: false
        in: path
        name: eventId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
          description: Success
      summary: Getting an event from its id
      tags:
      - Events
  /folders:
    get:
      description: This method renders folders.
      operationId: getAllFolders
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllFoldersResponse'
          description: Success
      summary: Getting all folders
      tags:
      - Folders
    post:
      description: This method creates a new folder. In case of success it renders
        the created folder, otherwise an error (422 HTTP code).
      operationId: createFolder
      parameters:
      - description: Folder’s label (mandatory).
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - description: ID of the parent folder.
        explode: true
        in: query
        name: parent_id
        required: false
        schema:
          type: string
        style: form
      - description: 'position of the folder. '
        explode: true
        in: query
        name: position
        required: false
        schema:
          type: integer
        style: form
      - description: 'query of the folder as described in ​Search API documentation.​\n\nExample:
          “​active_and_assigned_to_me:true”'
        explode: true
        in: query
        name: query
        required: false
        schema:
          type: string
        style: form
      - description: 'boolean describing display of the number of threads. '
        explode: true
        in: query
        name: render_threads_count
        required: false
        schema:
          type: boolean
        style: form
      - description: 'list of roles allowed to see this folder. This parameter has
          to be a hash otherwise it will raise a 400 error. The key should be "only".
          For example: `&role_restriction[only][]=4e5596cdae70f677b5000002`'
        explode: true
        in: query
        name: role_restriction[only][]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'list of teams allowed to see this folder. Same thing as role_restriction:
          team_restriction parameter has to be a hash with the key "only".'
        explode: true
        in: query
        name: team_restriction[only][]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: Success
      summary: Creating a folder
      tags:
      - Folders
  /folders/{folderId}:
    delete:
      description: This method destroys an existing folder. It renders the folder
        itself. It renders a 404 if id is invalid.
      operationId: deleteFolder
      parameters:
      - explode: false
        in: path
        name: folderId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: Success
      summary: Deleting a folder
      tags:
      - Folders
    get:
      description: This method renders a folder from given id.
      operationId: getFolder
      parameters:
      - explode: false
        in: path
        name: folderId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: Success
      summary: Getting a folder from its id
      tags:
      - Folders
    put:
      description: This method updates an existing folder from given attributes and
        renders it in case of success.
      operationId: updateFolder
      parameters:
      - explode: false
        in: path
        name: folderId
        required: true
        schema:
          type: string
        style: simple
      - description: Folder’s label (mandatory).
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - description: ID of the parent folder.
        explode: true
        in: query
        name: parent_id
        required: false
        schema:
          type: string
        style: form
      - description: 'position of the folder. '
        explode: true
        in: query
        name: position
        required: false
        schema:
          type: integer
        style: form
      - description: 'query of the folder as described in ​Search API documentation.​\n\nExample:
          “​active_and_assigned_to_me:true”'
        explode: true
        in: query
        name: query
        required: false
        schema:
          type: string
        style: form
      - description: 'boolean describing display of the number of threads. '
        explode: true
        in: query
        name: render_threads_count
        required: false
        schema:
          type: boolean
        style: form
      - description: 'list of roles allowed to see this folder. This parameter has
          to be a hash otherwise it will raise a 400 error. The key should be "only".
          For example: `&role_restriction[only][]=4e5596cdae70f677b5000002`'
        explode: true
        in: query
        name: role_restriction[only][]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'list of teams allowed to see this folder. Same thing as role_restriction:
          team_restriction parameter has to be a hash with the key "only".'
        explode: true
        in: query
        name: team_restriction[only][]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: Success
      summary: Updating a folder
      tags:
      - Folders
  /identities:
    get:
      description: This method renders identities ordered by creation date (descending).
        Only identities in sources where token’s user has “read” permission are returned.
      operationId: getAllIdentities
      parameters:
      - description: To filter identities on given community id.
        explode: true
        in: query
        name: community_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter on given group id.
        explode: true
        in: query
        name: identity_group_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter identities on given user id.
        explode: true
        in: query
        name: user_id
        required: false
        schema:
          type: string
        style: form
      - description: To change the criteria chosen to sort the identities. The value
          can be “created_at” or
        explode: true
        in: query
        name: sort
        required: false
        schema:
          enum:
          - created_at
          - updated_at
          type: string
        style: form
      - description: To filter identities on given user id
        explode: true
        in: query
        name: foreign_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter identities on given uuid
        explode: true
        in: query
        name: uuid
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllIdentitiesResponse'
          description: Success
      summary: Getting all identities
      tags:
      - Identities
  /identities/{identityId}:
    get:
      description: This method renders an identity from given id. If token’s user
        does not have “read” on identity’s source community a 404 HTTP response will
        be returned.
      operationId: getIdentity
      parameters:
      - explode: false
        in: path
        name: identityId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identity'
          description: Success
      summary: Getting an identity from its id
      tags:
      - Identities
  /identity_groups:
    get:
      description: |-
        This method renders identity groups ordered by creation date (descending). Note that identity_group are created in a lazily only when data are manually added to an identity OR a two identity are merged altogether. That means that some identity DON’T have identity_group, and identity_group do not cover all identities.

        Authorization​: no.
      operationId: getAllIdentityGroups
      parameters:
      - description: To filter groups on given firstname.
        explode: true
        in: query
        name: firstname
        required: false
        schema:
          type: string
        style: form
      - description: To filter groups on given lastname.
        explode: true
        in: query
        name: lastname
        required: false
        schema:
          type: string
        style: form
      - description: To filter groups that have given email.
        explode: true
        in: query
        name: email
        required: false
        schema:
          type: string
        style: form
      - description: To filter groups that have given uuid.
        explode: true
        in: query
        name: uuid
        required: false
        schema:
          type: string
        style: form
      - description: To change the criteria chosen to sort the identities. The value
          can be “created_at” or “updated_at”.
        explode: true
        in: query
        name: sort
        required: false
        schema:
          enum:
          - created_at
          - updated_at
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllIdentityGroupsResponse'
          description: Success
      summary: Getting all identity groups
      tags:
      - Identity Groups
  /identity_groups/{identityGroupId}:
    get:
      description: This method renders an identity group from given id.
      operationId: getIdentityGroup
      parameters:
      - explode: false
        in: path
        name: identityGroupId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityGroup'
          description: Success
      summary: Getting an identity group from its id
      tags:
      - Identity Groups
    put:
      description: |-
        This method updates an identity group from given attributes and renders it in case of success.

        Authorization​: no.
      operationId: updateIdentityGroup
      parameters:
      - explode: false
        in: path
        name: identityGroupId
        required: true
        schema:
          type: string
        style: simple
      - description: Identity company.
        explode: true
        in: query
        name: company
        required: false
        schema:
          type: string
        style: form
      - description: Identity custom field with key « custom_field_key ». It
        explode: true
        in: query
        name: custom_field_values[custom_field_key]
        required: false
        schema:
          type: string
        style: form
      - description: Identity emails (multiple).
        explode: true
        in: query
        name: emails
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Identity firstname.
        explode: true
        in: query
        name: firstname
        required: false
        schema:
          type: string
        style: form
      - description: Identity’s gender. It can be "man", "woman" or empty.
        explode: true
        in: query
        name: gender
        required: false
        schema:
          enum:
          - man
          - woman
          type: string
        style: form
      - description: Identity home phones (mutiple).
        explode: true
        in: query
        name: home_phones
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Identity lastname.
        explode: true
        in: query
        name: lastname
        required: false
        schema:
          type: string
        style: form
      - description: Identity mobile phones (multiple).
        explode: true
        in: query
        name: mobile_phones
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Identity notes.
        explode: true
        in: query
        name: notes
        required: false
        schema:
          type: string
        style: form
      - description: Identity tag ids (multiple).
        explode: true
        in: query
        name: tag_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityGroup'
          description: Success
      summary: Updating an identity group
      tags:
      - Identity Groups
  /intervention_comments:
    get:
      description: |-
        This method renders interventions comments ordered by creation date (descending). Only comments in sources where token’s user has “read” permission are returned.

        Authorization​: no.
      operationId: getAllInterventionComments
      parameters:
      - description: To filter comments on given intervention id.
        explode: true
        in: query
        name: intervention_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter comments on given thread id.
        explode: true
        in: query
        name: thread_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter comments on given user id.
        explode: true
        in: query
        name: user_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter comments on given identity id.
        explode: true
        in: query
        name: identity_id
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllInterventionCommentsResponse'
          description: Success
      summary: Getting all intervention comments
      tags:
      - Intervention Comments
    post:
      description: This method creates a new intervention comment. In case of success
        it renders the created comment, otherwise, it renders an error (422 HTTP code).
        It creates comment as token’s user. If token’s user does not have “read” on
        given intervention’s source a 404 HTTP response will be returned.
      operationId: createInterventionComment
      parameters:
      - description: The comment body (mandatory).
        explode: true
        in: query
        name: body
        required: true
        schema:
          type: string
        style: form
      - description: The comment intervention id (mandatory).
        explode: true
        in: query
        name: intervention_id
        required: true
        schema:
          type: string
        style: form
      - description: The comment user id (mandatory).
        explode: true
        in: query
        name: user_id
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterventionComment'
          description: Success
      summary: Creating an intervention comment
      tags:
      - Intervention Comments
  /intervention_comments/{interventionCommentId}:
    delete:
      description: |-
        This method destroys an intervention comment. It renders comment itself. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: deleteInterventionComment
      parameters:
      - explode: false
        in: path
        name: interventionCommentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterventionComment'
          description: Success
      summary: Deleting an intervention comment
      tags:
      - Intervention Comments
    get:
      description: This method renders an intervention comment from given id. If token’s
        user does not have “read” on comment’s source a 404 HTTP response will be
        returned.
      operationId: getInterventionComment
      parameters:
      - explode: false
        in: path
        name: interventionCommentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterventionComment'
          description: Success
      summary: Getting an intervention comment from its id
      tags:
      - Intervention Comments
  /interventions:
    get:
      description: |-
        This method renders interventions ordered by creation date (descending). Only interventions in sources where token’s user has “read” permission are returned.

        Authorization​: no.
      operationId: getAllInterventions
      parameters:
      - description: To filter interventions on given thread id.
        explode: true
        in: query
        name: thread_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter interventions on given user id.
        explode: true
        in: query
        name: user_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter interventions on given identity_group_id. This will
          return interventions associated to any identity in the indentity_group.
        explode: true
        in: query
        name: identity_group_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter interventions on given identity_id(s). Can be a single
          value or an array.
        explode: true
        in: query
        name: identity_id
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: To change the criteria chosen to sort the interventions. The
          value can be “created_at” or “updated_at”.
        explode: true
        in: query
        name: sort
        required: false
        schema:
          enum:
          - created_at
          - updated_at
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllInterventionsResponse'
          description: Success
      summary: Getting all interventions
      tags:
      - Interventions
    post:
      description: |-
        This method creates a new intervention or reopen it. In case of success it renders the intervention, otherwise, it renders an error (422 HTTP code). This method opens intervention as access token’s user.

        Authorization​: no, but it renders an error if intervention can’t be created or reopened (already opened, etc.).
      operationId: createIntervention
      parameters:
      - description: The content to create intervention on (mandatory).
        explode: true
        in: query
        name: content_id
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllInterventionsResponse'
          description: Success
        422:
          description: Unprocessable Entity
      summary: Creating an intervention
      tags:
      - Interventions
  /interventions/{interventionId}:
    get:
      description: |-
        This method renders an intervention from given id. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: getIntervention
      parameters:
      - explode: false
        in: path
        name: interventionId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Intervention'
          description: Success
      summary: Getting an intervention from its id
      tags:
      - Interventions
  /interventions/{interventionId}/cancel:
    delete:
      description: |-
        This method cancels (destroys) an intervention. It renders intervention itself. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned.

        Caveats:

        * If the intervention is already being canceled, it will return a 409 error.
        * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised:
          * Intervention MUST NOT already be closed
         * Intervention MUST NOT have agent replies
          * Access-Token agent MUST have read access on the source

        Authorization​: no, but it renders an error if intervention can’t be destroyed (see caveats).
      operationId: cancelIntervention
      parameters:
      - explode: false
        in: path
        name: interventionId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Intervention'
          description: Success
      summary: Cancelling an intervention
      tags:
      - Interventions
  /interventions/{interventionId}/close:
    put:
      description: |-
        This method closes an intervention. Caveats:

        * If the intervention is already being closed, it will return a 409 error.
        * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised:

          * Intervention MUST NOT already be closed

          * Intervention MUST have agent replies
          * Access-Token agent MUST be the owner of the intervention or have the permission to edit permissions

          * Access-Token agent MUST have read access on the source

        Authorization​: no, but it renders an error if intervention can’t be closed (see caveats)
      operationId: closeIntervention
      parameters:
      - explode: false
        in: path
        name: interventionId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Intervention'
          description: Success
        409:
          description: If the intervention is already being closed, it will return
            a 409 error.
      summary: Closing an intervention
      tags:
      - Interventions
  /interventions/{interventionId}/reassign:
    put:
      description: |-
        This method updates the user in charge of the intervention

        Authorization​: Only users who can update interventions.
      operationId: reassignIntervention
      parameters:
      - explode: false
        in: path
        name: interventionId
        required: true
        schema:
          type: string
        style: simple
      - explode: true
        in: query
        name: user_id
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Intervention'
          description: Success
      summary: Reassigning an intervention
      tags:
      - Interventions
  /interventions/{interventionId}/update_categories:
    put:
      description: |-
        This method updates the categories of an intervention. If token’s user does not have “read” on the intervention’s source a 404 HTTP response will be returned.

        Authorization​: no.
      operationId: categorizeIntervention
      parameters:
      - explode: false
        in: path
        name: interventionId
        required: true
        schema:
          type: string
        style: simple
      - explode: true
        in: query
        name: category_ids[]
        required: true
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Intervention'
          description: Success
      summary: Categorizing an intervention
      tags:
      - Interventions
  /locales:
    get:
      description: This method renders all available locales.
      operationId: getAllLocales
      responses:
        200:
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Locale'
                type: array
          description: List of all locales
      summary: Getting all locales
      tags:
      - Locales
  /presence_status:
    get:
      description: This method renders all presence statuses ordered by name (in alphabetical
        order).
      operationId: getAllPresenceStatus
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPresenceStatusResponse'
          description: Success
      summary: Getting all presence statuses
      tags:
      - Presence Status
    post:
      description: |-
        This method creates a presence status. In case of success it renders the presence status, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that have the right to monitor the task view.
      operationId: createPresenceStatus
      parameters:
      - description: The name of the presence status.
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceStatus'
          description: Success
      summary: Creating a presence status
      tags:
      - Presence Status
  /presence_status/{presenceStatusId}:
    delete:
      description: |-
        This method destroys an existing presence status. It renders presence status itself. It renders a 404 if id is invalid.

        Authorization​: only users that have the right to monitor the task view.
      operationId: deletePresenceStatus
      parameters:
      - explode: false
        in: path
        name: presenceStatusId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceStatus'
          description: Success
      summary: Deleting a presence status
      tags:
      - Presence Status
    get:
      description: |-
        This method renders a presence status from given id.

        Authorization​: only users that have the right to monitor the task view.
      operationId: getPresenceStatus
      parameters:
      - explode: false
        in: path
        name: presenceStatusId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceStatus'
          description: Success
      summary: Getting a presence status from its id
      tags:
      - Presence Status
    put:
      description: |-
        This method updates an existing presence status from given attributes and renders it in case of success.

        Authorization​: only users that have the right to monitor the task view.
      operationId: updatePresenceStatus
      parameters:
      - explode: false
        in: path
        name: presenceStatusId
        required: true
        schema:
          type: string
        style: simple
      - description: The name of the presence status.
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceStatus'
          description: Success
      summary: Updating a presence status
      tags:
      - Presence Status
  /reply_assistant/entries:
    get:
      description: |-
        This method renders all entries ordered by creation date (ascending).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getAllReplyAssistantEntries
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllReplyAssistantEntriesResponse'
          description: Success
      summary: Getting​ a​ll​ reply assistant e​ntries
      tags:
      - Reply Assistant Entries
    post:
      description: |-
        This method creates a reply assistant entry. In case of success it renders the entry, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: createReplyAssistantEntry
      parameters:
      - description: The name of the entry.
        explode: true
        in: query
        name: label
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantEntry'
          description: Success
      summary: Creating an entry
      tags:
      - Reply Assistant Entries
  /reply_assistant/entries/{replyAssistantEntryId}:
    delete:
      description: |-
        This method destroys an existing entry. It renders the entry itself. It renders a 404 if id is invalid.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: deleteReplyAssistantEntry
      parameters:
      - explode: false
        in: path
        name: replyAssistantEntryId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantEntry'
          description: Success
      summary: Deleting a reply assistant entry
      tags:
      - Reply Assistant Entries
    get:
      description: |-
        This method renders an entry from given id.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getReplyAssistantEntry
      parameters:
      - explode: false
        in: path
        name: replyAssistantEntryId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantEntry'
          description: Success
      summary: Getting a reply assistant entry from its id
      tags:
      - Reply Assistant Entries
    put:
      description: |-
        This method updates an existing entry from given attributes and renders it in case of success.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: updateReplyAssistantEntry
      parameters:
      - explode: false
        in: path
        name: replyAssistantEntryId
        required: true
        schema:
          type: string
        style: simple
      - description: The name of the entry.
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - description: 'The internal/company id of the entry. This is used to match
          Engage Digital entry’s id with the company one. Example: KB042.'
        explode: true
        in: query
        name: foreign_id
        required: false
        schema:
          type: string
        style: form
      - description: To restrict the entry to a set of Engage Digital categories.
          Then, KB entries that do not match message’s categories to which you are
          replying will not be suggested.
        explode: true
        in: query
        name: category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: entry shortcuts
        explode: true
        in: query
        name: shortcuts[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Entry group id.
        explode: true
        in: query
        name: entry_group_id
        required: false
        schema:
          type: string
        style: form
      - description: Source ids (array)
        explode: true
        in: query
        name: source_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantEntry'
          description: Success
      summary: Updating a reply assistant entry
      tags:
      - Reply Assistant Entries
  /reply_assistant/groups:
    get:
      description: |-
        This method renders all groups ordered by creation date (ascending).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getAllReplyAssistantGroups
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllReplyAssistantGroupsResponse'
          description: Success
      summary: Getting​ a​ll​ reply assistant groups
      tags:
      - Reply Assistant Groups
    post:
      description: |-
        This method creates an entry group. In case of success it renders the group, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: createReplyAssistantGroup
      parameters:
      - description: The name of the group.
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: List of the reply assistant entries in this group.
        explode: true
        in: query
        name: entry_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Used for autocompletion in chat.
        explode: true
        in: query
        name: autocomplete
        required: false
        schema:
          type: boolean
        style: form
      - description: Used to determine the order of the groups in the interface, in
          ascending order.
        explode: true
        in: query
        name: position
        required: false
        schema:
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantGroup'
          description: Success
      summary: Creating a reply assistant group
      tags:
      - Reply Assistant Groups
  /reply_assistant/groups/{replyAssistantGroupId}:
    delete:
      description: |-
        This method destroys an existing group. It renders the group itself. It renders a 404 if id is invalid.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: deleteReplyAssistantGroup
      parameters:
      - explode: false
        in: path
        name: replyAssistantGroupId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantGroup'
          description: Success
      summary: Deleting a reply assistant group
      tags:
      - Reply Assistant Groups
    get:
      description: |-
        This method renders an entry group from given id.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getReplyAssistantGroup
      parameters:
      - explode: false
        in: path
        name: replyAssistantGroupId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantGroup'
          description: Success
      summary: Getting a reply assistant group from its id
      tags:
      - Reply Assistant Groups
    put:
      description: |-
        This method updates an existing group from given attributes and renders it in case of success.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: updateReplyAssistantGroup
      parameters:
      - explode: false
        in: path
        name: replyAssistantGroupId
        required: true
        schema:
          type: string
        style: simple
      - description: The name of the group.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: List of the reply assistant entries in this group.
        explode: true
        in: query
        name: entry_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Used for autocompletion in chat.
        explode: true
        in: query
        name: autocomplete
        required: false
        schema:
          type: boolean
        style: form
      - description: Used to determine the order of the groups in the interface, in
          ascending order.
        explode: true
        in: query
        name: position
        required: false
        schema:
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantGroup'
          description: Success
      summary: Updating a reply assistant group
      tags:
      - Reply Assistant Groups
  /reply_assistant/versions:
    get:
      description: |-
        This method renders all reply assistant versions ordered by creation date (ascending).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getAllReplyAssistantVersions
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllReplyAssistantVersionsResponse'
          description: Success
      summary: Getting​ a​ll​ reply assistant versions
      tags:
      - Reply Assistant Versions
    post:
      description: |-
        This method creates a reply assistant version. In case of success it renders the version, otherwise, it renders an error (422 HTTP code, 404 if the entry_id is invalid).

        Authorization​: only users that have the right to manage reply assistant.
      operationId: createReplyAssistantVersion
      parameters:
      - description: Body of the version
        explode: true
        in: query
        name: body
        required: true
        schema:
          type: string
        style: form
      - description: Reply assistant entry id (mandatory)
        explode: true
        in: query
        name: entry_id
        required: true
        schema:
          type: string
        style: form
      - description: Source ids (array)
        explode: true
        in: query
        name: source_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Either “text” or “html”
        explode: true
        in: query
        name: format
        required: false
        schema:
          enum:
          - text
          - html
          type: string
        style: form
      - description: 'Language (ex: “fr”)'
        explode: true
        in: query
        name: language
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantVersion'
          description: Success
      summary: Creating a reply assistant version
      tags:
      - Reply Assistant Versions
  /reply_assistant/versions/{replyAssistantVersionId}:
    delete:
      description: |-
        This method destroys an existing version. It renders the version itself. It renders a 404 if id is invalid.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: deleteReplyAssistantVersion
      parameters:
      - explode: false
        in: path
        name: replyAssistantVersionId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantVersion'
          description: Success
      summary: Deleting a reply assistant version
      tags:
      - Reply Assistant Versions
    get:
      description: |-
        This method renders a version from given id.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: getReplyAssistantVersion
      parameters:
      - explode: false
        in: path
        name: replyAssistantVersionId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantVersion'
          description: Success
      summary: Getting a reply assistant version from its id
      tags:
      - Reply Assistant Versions
    put:
      description: |-
        This method updates an existing version from given attributes and renders it in case of success.

        Authorization​: only users that have the right to manage reply assistant.
      operationId: updateReplyAssistantVersion
      parameters:
      - explode: false
        in: path
        name: replyAssistantVersionId
        required: true
        schema:
          type: string
        style: simple
      - description: Body of the version
        explode: true
        in: query
        name: body
        required: false
        schema:
          type: string
        style: form
      - description: Reply assistant entry id.
        explode: true
        in: query
        name: entry_id
        required: false
        schema:
          type: string
        style: form
      - description: Source ids (array)
        explode: true
        in: query
        name: source_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Either “text” or “html”
        explode: true
        in: query
        name: format
        required: false
        schema:
          enum:
          - text
          - html
          type: string
        style: form
      - description: 'Language (ex: “fr”)'
        explode: true
        in: query
        name: language
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyAssistantVersion'
          description: Success
      summary: Updating a reply assistant version
      tags:
      - Reply Assistant Versions
  /roles:
    get:
      description: This method renders roles ordered by creation date (ascending).
      operationId: getAllRoles
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllRolesResponse'
          description: Success
      summary: Getting all roles
      tags:
      - Roles
    post:
      description: This method creates a new role. In case of success it renders the
        created role, otherwise, it renders an error (422 HTTP code).
      operationId: createRole
      parameters:
      - explode: true
        in: query
        name: label
        required: true
        schema:
          type: string
        style: form
      - explode: true
        in: query
        name: access_help_center
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: access_previous_messages
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: access_pull_mode
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: admin_stamp_answer
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: approve_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: assign_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: author_block_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: close_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_and_destroy_extension
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: delay_export_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: delete_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: impersonate_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: invite_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_api_access_tokens
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_app_sdk_applications
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_automatic_exports_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_categories
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_chat
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_custom_fields
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_custom_notifications
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_emails_templates
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_folders
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_ice
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_identities
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_own_notifications
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_reply_assistant
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_roles
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_rules_engine_rules
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_surveys
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_tags
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_teams
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_topologies
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_users_of_my_teams
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: monitor_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: monitor_team_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: mute_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: open_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: publish_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_event
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_export
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_identity
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_own_stats
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_presence
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_stats
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: read_surveys
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: receive_tasks
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: reply_with_assistant
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: search_contents
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: search_event
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_extension
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_identity
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_own_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_settings
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_time_sheet
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: use_emoji
        required: false
        schema:
          type: boolean
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Success
      summary: Creating a role
      tags:
      - Roles
  /roles/{roleId}:
    get:
      description: |-
        This method renders a role from given id.

        Authorization​: only users that can manage roles.
      operationId: getRole
      parameters:
      - explode: false
        in: path
        name: roleId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Success
      summary: Getting a role from its id
      tags:
      - Roles
    put:
      description: |-
        This method updates an existing role from given attributes and renders it in case of success.

        Authorization​: A user can’t update roles with more permissions than himself and can’t give a role a permission he doesn’t have.

        Any permission updated with a user that does not have this permission will be ignored (The update is done, just not the unallowed permission)
      operationId: updateRole
      parameters:
      - explode: false
        in: path
        name: roleId
        required: true
        schema:
          type: string
        style: simple
      - explode: true
        in: query
        name: access_help_center
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: access_previous_messages
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: access_pull_mode
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: admin_stamp_answer
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: approve_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: assign_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: author_block_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: close_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_and_destroy_extension
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: create_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: delay_export_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: delete_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: impersonate_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: invite_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_api_access_tokens
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_app_sdk_applications
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_automatic_exports_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_categories
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_chat
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_custom_fields
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_custom_notifications
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_emails_templates
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_folders
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_ice
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_identities
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_own_notifications
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_reply_assistant
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_roles
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_rules_engine_rules
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: manage_surveys
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_tags
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_teams
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_topologies
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: manage_users_of_my_teams
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: monitor_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: monitor_team_tasks
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: mute_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: open_content_thread
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: publish_content
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_event
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_export
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_identity
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_own_stats
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_presence
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_stats
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: read_surveys
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: read_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: receive_tasks
        required: false
        schema:
          type: boolean
        style: form
      - description: permission only available with the corresponding extension enabled
        explode: true
        in: query
        name: reply_with_assistant
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: search_contents
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: search_event
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_community
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_content_source
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_extension
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_identity
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_own_intervention
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_settings
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_time_sheet
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: update_user
        required: false
        schema:
          type: boolean
        style: form
      - explode: true
        in: query
        name: use_emoji
        required: false
        schema:
          type: boolean
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Success
      summary: Updating a role
      tags:
      - Roles
  /settings:
    get:
      description: |-
        This method renders all settings of your domain.

        Authorization​: only users that can update settings.
      operationId: getAllSettings
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
          description: Success
      summary: Getting all settings
      tags:
      - Settings
    put:
      description: |-
        This method updates the current domain settings.

        Authorization​: only users that can update settings.
      operationId: updateSettings
      parameters:
      - description: (in hours).
        explode: true
        in: query
        name: activity_presence_threshold
        required: false
        schema:
          type: integer
        style: form
      - description: ​Enable activity tracking (Boolean)
        explode: true
        in: query
        name: activity_tracking
        required: false
        schema:
          type: boolean
        style: form
      - description: (Day of week)
        explode: true
        in: query
        name: beginning_of_week
        required: false
        schema:
          type: string
        style: form
      - description: A​ ctivate the forced categorization by source.​ (Boolean)
        explode: true
        in: query
        name: category_tagging
        required: false
        schema:
          type: boolean
        style: form
      - description: (See format)
        explode: true
        in: query
        name: content_languages
        required: false
        schema:
          type: string
        style: form
      - description: Activate the dashboard (Boolean)
        explode: true
        in: query
        name: dashboard
        required: false
        schema:
          type: boolean
        style: form
      - description: Prevent the DD to be embed by other websites (Boolean)
        explode: true
        in: query
        name: deny_iframe_integration
        required: false
        schema:
          type: boolean
        style: form
      - description: (Boolean)
        explode: true
        in: query
        name: disable_password_autocomplete
        required: false
        schema:
          type: boolean
        style: form
      - description: password expiration delay (in seconds)
        explode: true
        in: query
        name: expire_password_after
        required: false
        schema:
          type: integer
        style: form
      - description: enable password expiration (Boolean)
        explode: true
        in: query
        name: expire_password_enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: provide durations in seconds in export (Boolean)
        explode: true
        in: query
        name: export_in_seconds
        required: false
        schema:
          type: boolean
        style: form
      - description: fold archived contents (Boolean)
        explode: true
        in: query
        name: fold_useless_contents
        required: false
        schema:
          type: boolean
        style: form
      - description: FTE data period (in hours)
        explode: true
        in: query
        name: fte_duration
        required: false
        schema:
          type: integer
        style: form
      - description: enable identity merge (Boolean)
        explode: true
        in: query
        name: identity_merge
        required: false
        schema:
          type: boolean
        style: form
      - description: (Array of times in seconds)
        explode: true
        in: query
        name: intervention_defer_rates[]
        required: false
        schema:
          items:
            type: integer
          type: array
        style: form
      - description: (in seconds)
        explode: true
        in: query
        name: intervention_defer_threshold
        required: false
        schema:
          type: integer
        style: form
      - description: (Array of times in seconds)
        explode: true
        in: query
        name: intervention_rates
        required: false
        schema:
          items:
            type: integer
          type: array
        style: form
      - description: locale code (String)
        explode: true
        in: query
        name: locale
        required: false
        schema:
          type: string
        style: form
      - description: activate multi language support for messages (Boolean)
        explode: true
        in: query
        name: multi_lang
        required: false
        schema:
          type: boolean
        style: form
      - description: Name of the Dimelo Digital (String)
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: prohibit reusing old passwords (Boolean)
        explode: true
        in: query
        name: password_archivable_enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: number of archived passwords
        explode: true
        in: query
        name: password_archivable_size
        required: false
        schema:
          type: integer
        style: form
      - description: minimum character length
        explode: true
        in: query
        name: password_min_length
        required: false
        schema:
          type: integer
        style: form
      - description: should contain at least 1 non alphanumeric char (Boolean)
        explode: true
        in: query
        name: password_non_word
        required: false
        schema:
          type: boolean
        style: form
      - description: should contain at least 1 number (Boolean)
        explode: true
        in: query
        name: password_numbers
        required: false
        schema:
          type: boolean
        style: form
      - description: disable password recovery by email (Boolean)
        explode: true
        in: query
        name: password_recovery_disabled
        required: false
        schema:
          type: boolean
        style: form
      - description: Enable push mode (Boolean)
        explode: true
        in: query
        name: push_enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: Enable reply as any identity (Boolean)
        explode: true
        in: query
        name: reply_as_any_identity
        required: false
        schema:
          type: boolean
        style: form
      - description: Enable right to left support (Boolean)
        explode: true
        in: query
        name: rtl_support
        required: false
        schema:
          type: boolean
        style: form
      - description: ​Allow authors to ask approval of their messages (Boolean)
        explode: true
        in: query
        name: self_approval_required
        required: false
        schema:
          type: boolean
        style: form
      - description: Session timeout (in minutes)
        explode: true
        in: query
        name: session_timeout
        required: false
        schema:
          type: integer
        style: form
      - description: Enable spellchecking (Boolean)
        explode: true
        in: query
        name: spellchecking
        required: false
        schema:
          type: boolean
        style: form
      - description: Defines the DD’s design (String)
        explode: true
        in: query
        name: style
        required: false
        schema:
          type: string
        style: form
      - description: Disable third-party services (tracking...) (Boolean)
        explode: true
        in: query
        name: third_party_services_disabled
        required: false
        schema:
          type: boolean
        style: form
      - description: Use the timezone endpoint to get the timezone name (String)
        explode: true
        in: query
        name: timezone
        required: false
        schema:
          type: string
        style: form
      - description: Track JS errors (Boolean)
        explode: true
        in: query
        name: track_js
        required: false
        schema:
          type: boolean
        style: form
      - description: Can be ‘demo’, ‘production’ or ‘archived’
        explode: true
        in: query
        name: type
        required: false
        schema:
          enum:
          - demo
          - production
          - archived
          type: string
        style: form
      - description: Chat max response time (in seconds)
        explode: true
        in: query
        name: urgent_task_threshold
        required: false
        schema:
          type: integer
        style: form
      - description: Experimental (Boolean)
        explode: true
        in: query
        name: use_system_font
        required: false
        schema:
          type: boolean
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
          description: Success
      summary: Updating settings
      tags:
      - Settings
  /status:
    get:
      description: |-
        This method get all currently connected agents & their status.

        Authorization​: only users that have the right to monitor the task view.
      operationId: getAllAgentStatus
      responses:
        200:
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentStatus'
                type: array
          description: Success
      summary: Get all connected agents status
      tags:
      - Agent Status
  /status/{agentId}:
    get:
      description: |-
        This method get the status of a connected agent. Returns a 404 if the user does not exist (not_found) or if he’s not connected (disconnected).

        Authorization​: only users that have the right to monitor the task view.
      operationId: getAgentStatus
      parameters:
      - explode: false
        in: path
        name: agentId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentStatus'
          description: Success
      summary: Get a connected agent status
      tags:
      - Agent Status
    put:
      description: |-
        This method updates an agent's availability. Can be used to set either channels statuses OR custom  status. If both parameters are provided, ignores custom status.The status parameter​ **MUST** b​e either “away” or “available”.

        Authorization​: only users that have the right to monitor the task view.
      operationId: changeAgentStatus
      parameters:
      - explode: false
        in: path
        name: agentId
        required: true
        schema:
          type: string
        style: simple
      - description: A hash of channel_id => availability (must contain all channels).
        explode: true
        in: query
        name: status
        required: false
        schema:
          type: string
        style: form
      - description: id of presence status (optional)
        explode: true
        in: query
        name: custom_status_id
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentStatus'
          description: Success
      summary: Changing an agent's status
      tags:
      - Agent Status
  /tags:
    get:
      description: This method renders tags ordered by name (ascending).
      operationId: getAllTags
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllTagsResponse'
          description: Success
      summary: Getting all tags
      tags:
      - Tags
    post:
      description: This method creates a new tag. In case of success it renders the
        created tag, otherwise, it renders an error (422 HTTP code).
      operationId: createTag
      parameters:
      - description: Tag name (mandatory).
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: Success
      summary: Creating a tag
      tags:
      - Tags
  /tags/{tagId}:
    delete:
      description: |-
        This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid.

        Authorization​: only users that are able to destroy tags.
      operationId: deleteTag
      parameters:
      - explode: false
        in: path
        name: tagId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: Success
      summary: Deleting a tag
      tags:
      - Tags
    get:
      description: This method renders a tag from given id.
      operationId: getTag
      parameters:
      - explode: false
        in: path
        name: tagId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: Success
      summary: Getting a tag from its id
      tags:
      - Tags
    put:
      description: |-
        This method updates an existing tag from given attributes and renders it in case of success.

        Authorization​: only users that are able to update tags.
      operationId: updateTag
      parameters:
      - explode: false
        in: path
        name: tagId
        required: true
        schema:
          type: string
        style: simple
      - description: Tag’s label.
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: Success
      summary: Updating a tag
      tags:
      - Tags
  /tasks:
    get:
      description: |-
        This method renders tasks ordered by priority (highest first) and then by creation date (latest first).

        Authorization​: only users that can read tasks.
      operationId: getAllTasks
      parameters:
      - description: 'To filter tasks on given queue name (filters on the “global”
          queue by default).The most commonly used queues are: “global” (contains
          every task pending assignation), “workbin_{agent_id}” (contains every tasks
          assigned to the {agent_id} agent, “history” (contains every processed tasks),
          and “undelivered” (contains every undelivered tasks). If queue is set to
          “workbins” all the tasks currently in a workbin will be returned.'
        explode: true
        in: query
        name: queue
        required: false
        schema:
          type: string
        style: form
      - description: To filter tasks on given channel id.
        explode: true
        in: query
        name: channel_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter tasks on the step they’re currently in.
        explode: true
        in: query
        name: step
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllTasksResponse'
          description: Success
      summary: Getting all tasks
      tags:
      - Tasks
  /tasks/{taskId}:
    get:
      description: This method renders a task from given id.
      operationId: getTask
      parameters:
      - explode: false
        in: path
        name: taskId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          description: Success
      summary: Getting a task from its id
      tags:
      - Tasks
  /tasks/{taskId}/move:
    delete:
      description: |-
        This method changes a task queue and renders it in case of success. Only accepts “undelivered” and special queue defined in topology (e.g. triage).

        Authorization​: only users that have the right to monitor the task view.
      operationId: moveTask
      parameters:
      - explode: false
        in: path
        name: taskId
        required: true
        schema:
          type: string
        style: simple
      - description: Name of the queue task has to be moved in.
        explode: true
        in: query
        name: queue
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          description: Success
      summary: Move a task to another queue
      tags:
      - Tasks
  /tasks/{taskId}/transfer:
    put:
      description: |-
        This method transfers an existing task and renders it in case of success.

        Authorization​: only users that have the right to monitor the task view.
      operationId: transferTask
      parameters:
      - explode: false
        in: path
        name: taskId
        required: true
        schema:
          type: string
        style: simple
      - description: List of agents to transfer the task to (multiple).
        explode: true
        in: query
        name: agent_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Force the transfer to the first agent in agent_ids if set. When
          bypass is used,
        explode: true
        in: query
        name: bypass
        required: false
        schema:
          type: string
        style: form
      - description: Filter agents receiving the task depending on their categories.
        explode: true
        in: query
        name: category_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Filter agents receiving the task depending on their spoken languages.
        explode: true
        in: query
        name: language
        required: false
        schema:
          type: string
        style: form
      - description: Filter agents receiving the task depending on their teams.
        explode: true
        in: query
        name: team_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Add a comment to the task.
        explode: true
        in: query
        name: comment
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          description: Success
      summary: Transferring a task
      tags:
      - Tasks
  /teams:
    get:
      description: This method renders teams ordered by creation date (ascending).
      operationId: getAllTeams
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllTeamsResponse'
          description: Success
      summary: Getting all teams
      tags:
      - Teams
    post:
      description: This method creates a new team. In case of success it renders the
        created tag, otherwise, it renders an error (422 HTTP code).
      operationId: createTeam
      parameters:
      - description: Team name.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: List of user id as leaders
        explode: true
        in: query
        name: leader_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: List of user id as team members.
        explode: true
        in: query
        name: user_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          description: Success
      summary: Creating a team
      tags:
      - Teams
  /teams/{teamId}:
    delete:
      description: This method destroys an existing team. It renders the team itself.
        It renders a 404 if id is invalid.
      operationId: deleteTeam
      parameters:
      - explode: false
        in: path
        name: teamId
        required: true
        schema:
          type: string
        style: simple
      - description: ID of a category to recategorize (optional).
        explode: true
        in: query
        name: take_over_category_id
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          description: Success
      summary: Deleting a team
      tags:
      - Teams
    get:
      description: This method renders a team from given id.
      operationId: getTeam
      parameters:
      - explode: false
        in: path
        name: teamId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          description: Success
      summary: Getting a team from its id
      tags:
      - Teams
    put:
      description: This method updates an existing team from given attributes and
        renders it in case of success.
      operationId: updateTeam
      parameters:
      - explode: false
        in: path
        name: teamId
        required: true
        schema:
          type: string
        style: simple
      - description: Team name.
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: List of user id as leaders
        explode: true
        in: query
        name: leader_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: List of user id as team members.
        explode: true
        in: query
        name: user_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          description: Success
      summary: Updating a team
      tags:
      - Teams
  /time_sheets:
    get:
      description: This method renders time sheets ordered by active and label.
      operationId: getAllTimeSheets
      parameters:
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllTimeSheetsResponse'
          description: Success
      summary: Getting all time sheets
      tags:
      - Time Sheets
    post:
      description: |-
        This method creates a time sheet. In case of success it renders the time sheet, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that can create time sheet.
      operationId: createTimeSheet
      parameters:
      - description: true or false, this field is used to enable/disable a time sheet.
        explode: true
        in: query
        name: active
        required: false
        schema:
          type: boolean
        style: form
      - description: The label of the time sheet.
        explode: true
        in: query
        name: label
        required: true
        schema:
          type: string
        style: form
      - description: An array containing id of each source using your time sheet.
        explode: true
        in: query
        name: source_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A string containing the first two letters of your country (example:
          "fr"/"en"/"es"), useful to bootstrap default holidays following to a country.'
        explode: true
        in: query
        name: holidays_region
        required: false
        schema:
          enum:
          - de
          - es
          - fr
          - gb
          - it
          - nl
          - us
          type: string
        style: form
      - description: An array containing one or more hash of holidays, a holiday must
          contain a name (string) and a date (string), the date must be in a valid
          format, a valid format is a format corresponding to your domain’s locale).
        explode: true
        in: query
        name: holidays
        required: false
        schema:
          type: string
        style: form
      - description: 'this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. For example:
          “a-b,c-d”: “a” is the beginning of the first interval of the day, “b” is
          the ending of the first interval of the day, “c” is the beginning of the
          second interval of the day, “d” is the ending of the second interval of
          the day'
        explode: true
        in: query
        name: monday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: tuesday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: wednesday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: thursday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: friday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: saturday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: sunday_hours
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSheet'
          description: Success
      summary: Creating a time sheet
      tags:
      - Time Sheets
  /time_sheets/{timeSheetId}:
    delete:
      description: This method destroys an existing time sheet. It renders time sheet
        itself. It renders a 404 if id is invalid.
      operationId: deleteTimeSheet
      parameters:
      - explode: false
        in: path
        name: timeSheetId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSheet'
          description: Success
      summary: Deleting a time sheet
      tags:
      - Time Sheets
    get:
      description: |-
        This method renders a time sheet from given id.

        Authorization​: only users that can see time sheets in administration section.
      operationId: getTimeSheet
      parameters:
      - explode: false
        in: path
        name: timeSheetId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSheet'
          description: Success
      summary: Getting a time sheet from its id
      tags:
      - Time Sheets
    put:
      description: This method updates an existing team from given attributes and
        renders it in case of success.
      operationId: updateTimeSheet
      parameters:
      - explode: false
        in: path
        name: timeSheetId
        required: true
        schema:
          type: string
        style: simple
      - description: true or false, this field is used to enable/disable a time sheet.
        explode: true
        in: query
        name: active
        required: false
        schema:
          type: boolean
        style: form
      - description: The label of the time sheet.
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - description: An array containing id of each source using your time sheet.
        explode: true
        in: query
        name: source_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: An array containing one or more hash of holidays, a holiday must
          contain a name (string) and a date (string), the date must be in a valid
          format, a valid format is a format corresponding to your domain’s locale).
        explode: true
        in: query
        name: holidays
        required: false
        schema:
          type: string
        style: form
      - description: 'this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. For example:
          “a-b,c-d”: “a” is the beginning of the first interval of the day, “b” is
          the ending of the first interval of the day, “c” is the beginning of the
          second interval of the day, “d” is the ending of the second interval of
          the day'
        explode: true
        in: query
        name: monday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: tuesday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: wednesday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: thursday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: friday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: saturday_hours
        required: false
        schema:
          type: string
        style: form
      - description: this field define the time intervals of the day (in secs). An
          empty string means that there are no business hours on this day. See `monday_hours`
          for the format.
        explode: true
        in: query
        name: sunday_hours
        required: false
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSheet'
          description: Success
      summary: Updating a time sheet
      tags:
      - Time Sheets
  /timezones:
    get:
      description: This method renders all available timezones.
      operationId: getAllTimezones
      responses:
        200:
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Timezone'
                type: array
          description: List of all timezones
      summary: Getting all timezones
      tags:
      - Timezones
  /users:
    get:
      description: |-
        This method renders users ordered by creation date (descending).

        Authorization​: only users that can view users. If the user affiliated to the token has the manage_users_of_my_teams permission, only the users belonging to at least one of the teams he’s the leader of will be returned.
      operationId: getAllUsers
      parameters:
      - description: To filter users on given email.
        explode: true
        in: query
        name: email
        required: false
        schema:
          type: string
        style: form
      - description: To filter users on given category id.
        explode: true
        in: query
        name: category_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter users on given identity id.
        explode: true
        in: query
        name: identity_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter users on given external id.
        explode: true
        in: query
        name: external_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter users on given role id.
        explode: true
        in: query
        name: role_id
        required: false
        schema:
          type: string
        style: form
      - description: To filter users on given team id.
        explode: true
        in: query
        name: team_id
        required: false
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllUsersResponse'
          description: Success
      summary: Getting all users
      tags:
      - Users
    post:
      description: This method creates a new user. In case of success it renders the
        created user, otherwise, it renders an error (422 HTTP code).
      operationId: createUser
      parameters:
      - description: User list of category ids (multiple).
        explode: true
        in: query
        name: category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User email (mandatory).
        explode: true
        in: query
        name: email
        required: true
        schema:
          type: string
        style: form
      - description: Whether the user is enabled or not (boolean).
        explode: true
        in: query
        name: enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: User external id, used for SSO.
        explode: true
        in: query
        name: external_id
        required: false
        schema:
          type: string
        style: form
      - description: User firstname (mandatory).
        explode: true
        in: query
        name: firstname
        required: true
        schema:
          type: string
        style: form
      - description: User gender ("man" or "woman").
        explode: true
        in: query
        name: gender
        required: false
        schema:
          enum:
          - man
          - woman
          type: string
        style: form
      - description: User list of identity ids (multiple).
        explode: true
        in: query
        name: identity_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User lastname (mandatory).
        explode: true
        in: query
        name: lastname
        required: true
        schema:
          type: string
        style: form
      - description: Language for the user interface.
        explode: true
        in: query
        name: locale
        required: false
        schema:
          type: string
        style: form
      - description: User nickname.
        explode: true
        in: query
        name: nickname
        required: false
        schema:
          type: string
        style: form
      - description: User plain password (mandatory).
        explode: true
        in: query
        name: password
        required: true
        schema:
          type: string
        style: form
      - description: User role id (mandatory).
        explode: true
        in: query
        name: role_id
        required: true
        schema:
          type: string
        style: form
      - description: User list of team ids (multiple).
        explode: true
        in: query
        name: team_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Use the timezone endpoint to get the timezone name (String),
          default is empty for domain timezone.
        explode: true
        in: query
        name: timezone
        required: false
        schema:
          type: string
        style: form
      - description: List of locales corresponding to the languages spoken by the
          user (multiple).
        explode: true
        in: query
        name: spoken_languages[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Success
      summary: Creating a user
      tags:
      - Users
  /users/invite:
    post:
      description: |-
        This method invites a new user. In case of success it renders the created user, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that can invite other users. If the user affiliated to the token has the manage_users_of_my_teams permission, the invited user will need to belong to at least one of the teams he’s the leader of. It will not be possible to assign the user to other teams.
      operationId: inviteUser
      parameters:
      - description: User list of category ids (multiple).
        explode: true
        in: query
        name: category_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User email (mandatory).
        explode: true
        in: query
        name: email
        required: true
        schema:
          type: string
        style: form
      - description: Whether the user is enabled or not (boolean).
        explode: true
        in: query
        name: enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: User external id.
        explode: true
        in: query
        name: external_id
        required: false
        schema:
          type: string
        style: form
      - description: User firstname (mandatory).
        explode: true
        in: query
        name: firstname
        required: true
        schema:
          type: string
        style: form
      - description: User gender ("man" or "woman").
        explode: true
        in: query
        name: gender
        required: false
        schema:
          enum:
          - man
          - woman
          type: string
        style: form
      - description: User list of identity ids (multiple).
        explode: true
        in: query
        name: identity_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User lastname (mandatory).
        explode: true
        in: query
        name: lastname
        required: true
        schema:
          type: string
        style: form
      - description: Language for the user interface.
        explode: true
        in: query
        name: locale
        required: false
        schema:
          type: string
        style: form
      - description: User nickname.
        explode: true
        in: query
        name: nickname
        required: false
        schema:
          type: string
        style: form
      - description: User role id (mandatory).
        explode: true
        in: query
        name: role_id
        required: true
        schema:
          type: string
        style: form
      - description: User list of team ids (multiple).
        explode: true
        in: query
        name: team_ids
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Use the timezone endpoint to get the timezone name (String),
          default is empty for
        explode: true
        in: query
        name: timezone
        required: false
        schema:
          type: string
        style: form
      - description: List of locales corresponding to the languages spoken by the
          user (multiple).
        explode: true
        in: query
        name: spoken_languages
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Success
        422:
          description: Unprocessable Entity
      summary: Inviting a user
      tags:
      - Users
  /users/{userId}:
    delete:
      description: |-
        This method deletes the given user. In case of success it renders the deleted user, otherwise, it renders an error (422 HTTP code).

        Authorization​: only users that can update users. The user affiliated to the token must have at least all the permissions of the other user. If the user affiliated to the token has the manage_users_of_my_teams permission, the deleted user will need to belong to at least one of the teams he’s the leader of.
      operationId: deleteUser
      parameters:
      - explode: false
        in: path
        name: userId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Success
      summary: Deleting a user
      tags:
      - Users
    get:
      description: This method renders a user from given id.
      operationId: getUser
      parameters:
      - explode: false
        in: path
        name: userId
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Success
      summary: Getting a user from its id
      tags:
      - Users
    put:
      description: |-
        This method updates users from given attributes and renders it in case of success.

        Authorization​: only users that can update users. If the user affiliated to the token has the `manage_users_of_my_teams` permission, the updated user will need to belong to at least one of the teams he’s the leader of. The teams the user affiliated to the token is the leader of will be the only ones which can be added or removed.
      operationId: updateUser
      parameters:
      - explode: false
        in: path
        name: userId
        required: true
        schema:
          type: string
        style: simple
      - description: User list of category ids (multiple).
        explode: true
        in: query
        name: category_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User email.
        explode: true
        in: query
        name: email
        required: false
        schema:
          type: string
        style: form
      - description: Whether the user is enabled or not (boolean).
        explode: true
        in: query
        name: enabled
        required: false
        schema:
          type: boolean
        style: form
      - description: User external id, used for SSO.
        explode: true
        in: query
        name: external_id
        required: false
        schema:
          type: string
        style: form
      - description: User firstname.
        explode: true
        in: query
        name: firstname
        required: false
        schema:
          type: string
        style: form
      - description: User gender ("man" or "woman").
        explode: true
        in: query
        name: gender
        required: false
        schema:
          enum:
          - man
          - woman
          type: string
        style: form
      - description: User list of identity ids (multiple).
        explode: true
        in: query
        name: identity_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: User lastname.
        explode: true
        in: query
        name: lastname
        required: false
        schema:
          type: string
        style: form
      - description: Language for the user interface.
        explode: true
        in: query
        name: locale
        required: false
        schema:
          type: string
        style: form
      - description: User nickname.
        explode: true
        in: query
        name: nickname
        required: false
        schema:
          type: string
        style: form
      - description: User plain password.
        explode: true
        in: query
        name: password
        required: false
        schema:
          type: string
        style: form
      - description: User role id.
        explode: true
        in: query
        name: role_id
        required: false
        schema:
          type: string
        style: form
      - description: User list of team ids (multiple).
        explode: true
        in: query
        name: team_ids[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      - description: Use the timezone endpoint to get the timezone name (String),
          default is empty for domain timezone.
        explode: true
        in: query
        name: timezone
        required: false
        schema:
          type: string
        style: form
      - description: List of locales corresponding to the languages spoken by the
          user (multiple).
        explode: true
        in: query
        name: spoken_languages[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Success
      summary: Updating a user
      tags:
      - Users
  /webhooks:
    get:
      description: |-
        This method renders webhooks ordered by active and staging_use (descending).

        Authorization​: users having manage_api_access_tokens permission can see all webhooks / users don’t having the manage_api_access_tokens permission can see only the webhooks belonging to access token created by them.
      operationId: getAllWebhooks
      parameters:
      - description: Access token.
        explode: true
        in: query
        name: access_token
        required: true
        schema:
          type: string
        style: form
      - description: The record index to start. Default value is 0.
        explode: true
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
        style: form
      - description: The max number of records to return. Default value is 30, max
          value is 150.
        explode: true
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllWebhooksResponse'
          description: Success
      summary: Getting all webhooks
      tags:
      - Webhooks
    post:
      description: |-
        This method creates a webhook. In case of success it renders the webhook, otherwise, it renders an error (422 HTTP code).

        Authorization​: All users having the manage_api_access_tokens permission or all users having an api access token.
      operationId: createWebhook
      parameters:
      - description: Access token.
        explode: true
        in: query
        name: access_token
        required: true
        schema:
          type: string
        style: form
      - description: true or false, this field is used to enable/disable a webhook.
        explode: true
        in: query
        name: active
        required: false
        schema:
          type: boolean
        style: form
      - description: The label of the webhook.
        explode: true
        in: query
        name: label
        required: true
        schema:
          type: string
        style: form
      - description: true or false, this field is used to determine if a webhook will
          be run in staging
        explode: true
        in: query
        name: staging_use
        required: false
        schema:
          type: boolean
        style: form
      - description: The url of a webhook. This is used to determine the endpoint
          of your webhook, where
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      - description: The token used in your webhook.
        explode: true
        in: query
        name: verify_token
        required: false
        schema:
          type: string
        style: form
      - description: The secret key that will be served as a ​`X-Dimelo-Secret​` header
          in every request.
        explode: true
        in: query
        name: secret
        required: false
        schema:
          type: string
        style: form
      - description: An array containing all the events that your webhook wants to
          subscribe.
        explode: true
        in: query
        name: registered_events[]
        required: true
        schema:
          items:
            enum:
            - api_access_token.created
            - api_access_token.destroyed
            - api_access_token.updated
            - automatic_exports_task.created
            - automatic_exports_task.destroyed
            - automatic_exports_task.failed
            - automatic_exports_task.succeed
            - automatic_exports_task.updated
            - category.created
            - category.destroyed
            - category.updated
            - community.created
            - community.destroyed
            - community.updated
            - content.admin_stamped
            - content.approved
            - content.author_blocked
            - content.author_stamped
            - content.author_unblocked
            - content.auto_categorization_infirmed
            - content.auto_categorization_not_precise
            - content.auto_categorized
            - content.auto_ignored
            - content.categorized
            - content.destroyed
            - content.discussion_initiated
            - content.discussion_planned
            - content.ice_nth_content_ignored
            - content.ignored
            - content.imported
            - content.liked
            - content.moderated_ban
            - content.moderated_modif
            - content.moderated_nok
            - content.moderated_ok
            - content.planned_discussion_synchronized
            - content.published
            - content.recategorized
            - content.replied
            - content.reply_assistant_used
            - content.retried_synchronization
            - content.retweeted
            - content.source_changed
            - content.stared
            - content.thread_closed
            - content.thread_opened
            - content.unliked
            - content.unpublished
            - content.unstamped
            - content.unstared
            - content.updated
            - content_source.created
            - content_source.destroyed
            - content_source.updated
            - content_thread.categorized
            - content_thread.destroyed
            - content_thread.recategorized
            - custom_field.created
            - custom_field.destroyed
            - custom_field.updated
            - expired_data_purge.deleted
            - extension.created
            - extension.destroyed
            - extension.updated
            - folder.created
            - folder.destroyed
            - folder.updated
            - identity.followed
            - identity.unfollowed
            - identity.updated
            - intervention.assigned
            - intervention.canceled
            - intervention.closed
            - intervention.deferred
            - intervention.opened
            - intervention.recategorized
            - intervention.reopened
            - intervention.updated
            - intervention.user_updated
            - intervention_comment.created
            - intervention_comment.destroyed
            - reply_assistant_knowledge_base_entry.created
            - reply_assistant_knowledge_base_entry.destroyed
            - reply_assistant_knowledge_base_entry.updated
            - reply_assistant_knowledge_base_version.created
            - reply_assistant_knowledge_base_version.destroyed
            - reply_assistant_knowledge_base_version.updated
            - reply_assistant_sentence_entry.created
            - reply_assistant_sentence_entry.destroyed
            - reply_assistant_sentence_entry.updated
            - reply_assistant_sentence_version.created
            - reply_assistant_sentence_version.destroyed
            - reply_assistant_sentence_version.updated
            - reply_assistant_version_permalink.created
            - reply_assistant_version_permalink.destroyed
            - reply_assistant_version_permalink.updated
            - role.created
            - role.destroyed
            - role.updated
            - security.updated
            - session.created
            - session.destroyed
            - settings.updated
            - survey.created
            - survey.destroyed
            - survey.updated
            - tag.created
            - tag.destroyed
            - tag.updated
            - team.created
            - team.destroyed
            - team.updated
            - user.created
            - user.destroyed
            - user.disconnected
            - user.impersonated
            - user.invited
            - user.notifications_updated
            - user.updated
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Success
      summary: Creating a webhook
      tags:
      - Webhooks
  /webhooks/{webhookId}:
    delete:
      description: |-
        This method destroys an existing webhook. It renders webhook itself. It renders a 404 if id is invalid.

        Authorization​: All users having the manage_api_access_tokens permission or all users having an api access token belonging to the webhook you’re deleting.
      operationId: deleteWebhook
      parameters:
      - explode: false
        in: path
        name: webhookId
        required: true
        schema:
          type: string
        style: simple
      - description: Access token.
        explode: true
        in: query
        name: access_token
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Success
      summary: Deleting a webhook
      tags:
      - Webhooks
    get:
      description: |-
        This method renders a webhook from given id.

        Authorization​: users having manage_api_access_tokens permission can see any webhook / users don’t having the `manage_api_access_tokens` permission can see only the webhook in case the webhook is associated to an access token created by them.
      operationId: getWebhook
      parameters:
      - explode: false
        in: path
        name: webhookId
        required: true
        schema:
          type: string
        style: simple
      - description: Access token.
        explode: true
        in: query
        name: access_token
        required: true
        schema:
          type: string
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Success
      summary: Getting a webhook from its id
      tags:
      - Webhooks
    put:
      description: |-
        This method updates an existing webhook from given attributes and renders it in case of success.

        Authorization​: All users having the manage_api_access_tokens permission or all users having an api access token belonging to the webhook you’re updating.
      operationId: updateWebhook
      parameters:
      - explode: false
        in: path
        name: webhookId
        required: true
        schema:
          type: string
        style: simple
      - description: Access token.
        explode: true
        in: query
        name: access_token
        required: true
        schema:
          type: string
        style: form
      - description: true or false, this field is used to enable/disable a webhook.
        explode: true
        in: query
        name: active
        required: false
        schema:
          type: boolean
        style: form
      - description: The label of the webhook.
        explode: true
        in: query
        name: label
        required: false
        schema:
          type: string
        style: form
      - description: true or false, this field is used to determine if a webhook will
          be run in staging
        explode: true
        in: query
        name: staging_use
        required: false
        schema:
          type: boolean
        style: form
      - description: The url of a webhook. This is used to determine the endpoint
          of your webhook, where
        explode: true
        in: query
        name: url
        required: false
        schema:
          type: string
        style: form
      - description: The token used in your webhook.
        explode: true
        in: query
        name: verify_token
        required: false
        schema:
          type: string
        style: form
      - description: The secret key that will be served as a ​`X-Dimelo-Secret​` header
          in every request.
        explode: true
        in: query
        name: secret
        required: false
        schema:
          type: string
        style: form
      - description: An array containing all the events that your webhook wants to
          subscribe.
        explode: true
        in: query
        name: registered_events[]
        required: false
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Success
      summary: Updating a webhook
      tags:
      - Webhooks
components:
  schemas:
    AgentCustomStatus:
      description: |-
        The "custom_status" attribute represent the custom "away" status selected, it can either be:
        * 1. null — ​The agent is available or in the generic "Away" status
        2. { "id":"5582b1f4776562af9b000008" } — ​The id of the custom status
      example:
        id: id
      properties:
        id:
          type: string
    AgentStatus:
      example:
        agent_id: agent_id
        channels:
        - busyness: unoccupied
          name: name
          id: id
          status: status
        - busyness: unoccupied
          name: name
          id: id
          status: status
        custom_status:
          id: id
      properties:
        agent_id:
          type: string
        channels:
          items:
            $ref: '#/components/schemas/AgentStatusChannel'
          type: array
        custom_status:
          $ref: '#/components/schemas/AgentCustomStatus'
    AgentStatusChannel:
      example:
        busyness: unoccupied
        name: name
        id: id
        status: status
      properties:
        busyness:
          enum:
          - unoccupied
          - ok
          - busy
          - full
          type: string
        id:
          type: string
        name:
          type: string
        status:
          type: string
    Attachment:
      example:
        foreign_id: foreign_id
        video_metadata:
        - video_metadata
        - video_metadata
        filename: filename
        content_type: content_type
        size: 5
        updated_at: 2000-01-23T04:56:07.000+00:00
        created_at: 2000-01-23T04:56:07.000+00:00
        embed: true
        id: id
        public?: true
        url: url
      properties:
        content_type:
          type: string
        created_at:
          format: date-time
          type: string
        embed:
          type: boolean
        filename:
          type: string
        foreign_id:
          type: string
        id:
          type: string
        public?:
          type: boolean
        size:
          type: integer
        updated_at:
          format: date-time
          type: string
        url:
          type: string
        video_metadata:
          items:
            type: string
          type: array
    Category:
      example:
        source_ids:
        - source_ids
        - source_ids
        color: 5
        updated_at: 2000-01-23T04:56:07.000+00:00
        parent_id: parent_id
        multiple: true
        name: name
        unselectable: true
        created_at: 2000-01-23T04:56:07.000+00:00
        post_qualification: true
        id: id
        mandatory: true
      properties:
        color:
          type: integer
        created_at:
          format: date-time
          type: string
        id:
          type: string
        mandatory:
          type: boolean
        multiple:
          type: boolean
        name:
          type: string
        parent_id:
          type: string
        post_qualification:
          type: boolean
        source_ids:
          items:
            type: string
          type: array
        unselectable:
          type: boolean
        updated_at:
          format: date-time
          type: string
      required:
      - id
    Channel:
      example:
        source_ids:
        - source_ids
        - source_ids
        updated_at: 2000-01-23T04:56:07.000+00:00
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        soft_capability: 5
        id: id
        label: label
        task_timeout_seconds: 2
        hard_capability: 5
      properties:
        created_at:
          format: date-time
          type: string
        hard_capability:
          type: integer
        id:
          type: string
        label:
          type: string
        name:
          type: string
        soft_capability:
          type: integer
        source_ids:
          items:
            type: string
          type: array
        task_timeout_seconds:
          type: integer
        updated_at:
          format: date-time
          type: string
    Community:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        name: name
        active: true
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
        type: type
      properties:
        active:
          type: boolean
        created_at:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
    Content:
      example:
        private_message: true
        intervention_id: intervention_id
        attachments:
        - foreign_id: foreign_id
          filename: filename
          content_type: content_type
          size: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          created_at: 2000-01-23T04:56:07.000+00:00
          embed: embed
          id: id
          public?: public?
          url: url
        - foreign_id: foreign_id
          filename: filename
          content_type: content_type
          size: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          created_at: 2000-01-23T04:56:07.000+00:00
          embed: embed
          id: id
          public?: public?
          url: url
        in_reply_to_id: in_reply_to_id
        created_at: 2000-01-23T04:56:07.000+00:00
        language: language
        body: body
        title: title
        type: type
        source_url: source_url
        synchronization_status: synchronization_status
        thread_id: thread_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        body_input_format: text
        category_ids:
        - category_ids
        - category_ids
        id: id
        remotely_deleted: true
        approval_required: true
        source_type: source_type
        published: true
        body_formatted:
          html: html
          text: text
        foreign_id: foreign_id
        context_data: '{}'
        in_reply_to_author_id: in_reply_to_author_id
        creator_id: creator_id
        attachments_count: 5
        source_id: source_id
        author_id: author_id
        created_from: created_from
        status: status
      properties:
        approval_required:
          type: boolean
        attachments:
          items:
            $ref: '#/components/schemas/ContentAttachment'
          type: array
        attachments_count:
          type: integer
        author_id:
          type: string
        body:
          type: string
        body_formatted:
          $ref: '#/components/schemas/ContentBodyFormatted'
        body_input_format:
          description: 'values can be: text or html.'
          enum:
          - text
          - html
          type: string
        category_ids:
          description: are content categories if none, they are default to intervention
            categories or thread categories
          items:
            type: string
          type: array
        context_data:
          description: is present only if the content has context_data associated.
            The context_data hash keys are the custom fields keys.
          type: object
        created_at:
          format: date-time
          type: string
        created_from:
          type: string
        creator_id:
          type: string
        foreign_id:
          type: string
        id:
          type: string
        in_reply_to_author_id:
          type: string
        in_reply_to_id:
          type: string
        intervention_id:
          type: string
        language:
          type: string
        private_message:
          type: boolean
        published:
          type: boolean
        remotely_deleted:
          type: boolean
        source_id:
          type: string
        source_type:
          type: string
        source_url:
          type: string
        status:
          type: string
        synchronization_status:
          type: string
        thread_id:
          type: string
        title:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
    ContentAttachment:
      example:
        foreign_id: foreign_id
        filename: filename
        content_type: content_type
        size: 5
        updated_at: 2000-01-23T04:56:07.000+00:00
        created_at: 2000-01-23T04:56:07.000+00:00
        embed: embed
        id: id
        public?: public?
        url: url
      properties:
        content_type:
          type: string
        created_at:
          format: date-time
          type: string
        embed:
          type: string
        filename:
          type: string
        foreign_id:
          type: string
        id:
          type: string
        public?:
          type: string
        size:
          type: integer
        updated_at:
          format: date-time
          type: string
        url:
          description: 'You can download the attachments by using an API access token
            with the following URL: https://[your-domain].engagement.dimelo.com/attachments/[attachment_id]?access_token=[your_​
            access_token]'
          type: string
    ContentBodyFormatted:
      description: always contains text a​nd​ html versions.
      example:
        html: html
        text: text
      properties:
        html:
          type: string
        text:
          type: string
    CustomField:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        multiple: true
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
        label: label
        position: 5
        type: type
        associated_type_name: associated_type_name
        key: key
      properties:
        associated_type_name:
          type: string
        created_at:
          format: date-time
          type: string
        id:
          type: string
        key:
          type: string
        label:
          type: string
        multiple:
          type: boolean
        position:
          type: integer
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - label
    Event:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        extra_infos:
          intervention_id: intervention_id
          request_ip: request_ip
          authentication_strategy: authentication_strategy
          business/time_sheet_id: business/time_sheet_id
          content_id: content_id
          deletions: '{}'
          deferred_duration: deferred_duration
          task_id: task_id
          closed_automatically: closed_automatically
          content_thread_id: content_thread_id
          foreign_id: foreign_id
          user_id: user_id
          content_source_id: content_source_id
          category_ids:
          - category_ids
          - category_ids
        user_id: user_id
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        created_at:
          format: date-time
          type: string
        extra_infos:
          $ref: '#/components/schemas/EventExtraInfo'
        id:
          type: string
        name:
          type: string
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
      required:
      - id
    EventExtraInfo:
      description: attributes in extra_infos are optional and unspecified/not guaranteed,
        don’t rely on it for critical tasks, this is provided as information only
      example:
        intervention_id: intervention_id
        request_ip: request_ip
        authentication_strategy: authentication_strategy
        business/time_sheet_id: business/time_sheet_id
        content_id: content_id
        deletions: '{}'
        deferred_duration: deferred_duration
        task_id: task_id
        closed_automatically: closed_automatically
        content_thread_id: content_thread_id
        foreign_id: foreign_id
        user_id: user_id
        content_source_id: content_source_id
        category_ids:
        - category_ids
        - category_ids
      properties:
        authentication_strategy:
          type: string
        business/time_sheet_id:
          type: string
        category_ids:
          items:
            type: string
          type: array
        closed_automatically:
          type: string
        content_id:
          type: string
        content_source_id:
          type: string
        content_thread_id:
          type: string
        deferred_duration:
          type: string
        deletions:
          type: object
        foreign_id:
          description: can be null
          type: string
        intervention_id:
          type: string
        request_ip:
          type: string
        task_id:
          type: string
        user_id:
          type: string
    Folder:
      example:
        render_threads_count: true
        updated_at: 2000-01-23T04:56:07.000+00:00
        parent_id: parent_id
        query: query
        created_at: 2000-01-23T04:56:07.000+00:00
        role_restriction:
          only:
          - only
          - only
        id: id
        label: label
        position: 5
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        label:
          type: string
        parent_id:
          type: string
        position:
          type: integer
        query:
          type: string
        render_threads_count:
          type: boolean
        role_restriction:
          $ref: '#/components/schemas/Restriction'
        updated_at:
          format: date-time
          type: string
      required:
      - id
    GetAllAgentStatusResponse:
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/AgentStatus'
          type: array
    GetAllAttachmentsResponse:
      example:
        offset: 1
        records:
        - foreign_id: foreign_id
          video_metadata:
          - video_metadata
          - video_metadata
          filename: filename
          content_type: content_type
          size: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          created_at: 2000-01-23T04:56:07.000+00:00
          embed: true
          id: id
          public?: true
          url: url
        - foreign_id: foreign_id
          video_metadata:
          - video_metadata
          - video_metadata
          filename: filename
          content_type: content_type
          size: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          created_at: 2000-01-23T04:56:07.000+00:00
          embed: true
          id: id
          public?: true
          url: url
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
    GetAllCategoriesResponse:
      example:
        offset: 1
        records:
        - source_ids:
          - source_ids
          - source_ids
          color: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          parent_id: parent_id
          multiple: true
          name: name
          unselectable: true
          created_at: 2000-01-23T04:56:07.000+00:00
          post_qualification: true
          id: id
          mandatory: true
        - source_ids:
          - source_ids
          - source_ids
          color: 5
          updated_at: 2000-01-23T04:56:07.000+00:00
          parent_id: parent_id
          multiple: true
          name: name
          unselectable: true
          created_at: 2000-01-23T04:56:07.000+00:00
          post_qualification: true
          id: id
          mandatory: true
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Category'
          type: array
    GetAllChannelsResponse:
      example:
        offset: 1
        records:
        - source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          soft_capability: 5
          id: id
          label: label
          task_timeout_seconds: 2
          hard_capability: 5
        - source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          soft_capability: 5
          id: id
          label: label
          task_timeout_seconds: 2
          hard_capability: 5
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Channel'
          type: array
    GetAllCommunitiesResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          type: type
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          type: type
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Community'
          type: array
    GetAllContentsResponse:
      example:
        offset: 1
        records:
        - private_message: true
          intervention_id: intervention_id
          attachments:
          - foreign_id: foreign_id
            filename: filename
            content_type: content_type
            size: 5
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            embed: embed
            id: id
            public?: public?
            url: url
          - foreign_id: foreign_id
            filename: filename
            content_type: content_type
            size: 5
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            embed: embed
            id: id
            public?: public?
            url: url
          in_reply_to_id: in_reply_to_id
          created_at: 2000-01-23T04:56:07.000+00:00
          language: language
          body: body
          title: title
          type: type
          source_url: source_url
          synchronization_status: synchronization_status
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          body_input_format: text
          category_ids:
          - category_ids
          - category_ids
          id: id
          remotely_deleted: true
          approval_required: true
          source_type: source_type
          published: true
          body_formatted:
            html: html
            text: text
          foreign_id: foreign_id
          context_data: '{}'
          in_reply_to_author_id: in_reply_to_author_id
          creator_id: creator_id
          attachments_count: 5
          source_id: source_id
          author_id: author_id
          created_from: created_from
          status: status
        - private_message: true
          intervention_id: intervention_id
          attachments:
          - foreign_id: foreign_id
            filename: filename
            content_type: content_type
            size: 5
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            embed: embed
            id: id
            public?: public?
            url: url
          - foreign_id: foreign_id
            filename: filename
            content_type: content_type
            size: 5
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            embed: embed
            id: id
            public?: public?
            url: url
          in_reply_to_id: in_reply_to_id
          created_at: 2000-01-23T04:56:07.000+00:00
          language: language
          body: body
          title: title
          type: type
          source_url: source_url
          synchronization_status: synchronization_status
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          body_input_format: text
          category_ids:
          - category_ids
          - category_ids
          id: id
          remotely_deleted: true
          approval_required: true
          source_type: source_type
          published: true
          body_formatted:
            html: html
            text: text
          foreign_id: foreign_id
          context_data: '{}'
          in_reply_to_author_id: in_reply_to_author_id
          creator_id: creator_id
          attachments_count: 5
          source_id: source_id
          author_id: author_id
          created_from: created_from
          status: status
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Content'
          type: array
    GetAllCustomFieldsResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          multiple: true
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          label: label
          position: 5
          type: type
          associated_type_name: associated_type_name
          key: key
        - updated_at: 2000-01-23T04:56:07.000+00:00
          multiple: true
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          label: label
          position: 5
          type: type
          associated_type_name: associated_type_name
          key: key
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/CustomField'
          type: array
    GetAllEventsResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          extra_infos:
            intervention_id: intervention_id
            request_ip: request_ip
            authentication_strategy: authentication_strategy
            business/time_sheet_id: business/time_sheet_id
            content_id: content_id
            deletions: '{}'
            deferred_duration: deferred_duration
            task_id: task_id
            closed_automatically: closed_automatically
            content_thread_id: content_thread_id
            foreign_id: foreign_id
            user_id: user_id
            content_source_id: content_source_id
            category_ids:
            - category_ids
            - category_ids
          user_id: user_id
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        - updated_at: 2000-01-23T04:56:07.000+00:00
          extra_infos:
            intervention_id: intervention_id
            request_ip: request_ip
            authentication_strategy: authentication_strategy
            business/time_sheet_id: business/time_sheet_id
            content_id: content_id
            deletions: '{}'
            deferred_duration: deferred_duration
            task_id: task_id
            closed_automatically: closed_automatically
            content_thread_id: content_thread_id
            foreign_id: foreign_id
            user_id: user_id
            content_source_id: content_source_id
            category_ids:
            - category_ids
            - category_ids
          user_id: user_id
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Event'
          type: array
    GetAllFoldersResponse:
      example:
        offset: 1
        records:
        - render_threads_count: true
          updated_at: 2000-01-23T04:56:07.000+00:00
          parent_id: parent_id
          query: query
          created_at: 2000-01-23T04:56:07.000+00:00
          role_restriction:
            only:
            - only
            - only
          id: id
          label: label
          position: 5
        - render_threads_count: true
          updated_at: 2000-01-23T04:56:07.000+00:00
          parent_id: parent_id
          query: query
          created_at: 2000-01-23T04:56:07.000+00:00
          role_restriction:
            only:
            - only
            - only
          id: id
          label: label
          position: 5
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Folder'
          type: array
    GetAllIdentitiesResponse:
      example:
        offset: 1
        records:
        - home_phone: home_phone
          firstname: firstname
          extra_values: '{}'
          gender: gender
          user_ids:
          - user_ids
          - user_ids
          created_at: 2000-01-23T04:56:07.000+00:00
          display_name: display_name
          type: type
          uuid: uuid
          community_url: community_url
          lastname: lastname
          foreign_id: foreign_id
          community_id: community_id
          avatar_url: avatar_url
          updated_at: 2000-01-23T04:56:07.000+00:00
          mobile_phone: mobile_phone
          identity_group_id: identity_group_id
          company: company
          id: id
          screenname: screenname
          email: email
        - home_phone: home_phone
          firstname: firstname
          extra_values: '{}'
          gender: gender
          user_ids:
          - user_ids
          - user_ids
          created_at: 2000-01-23T04:56:07.000+00:00
          display_name: display_name
          type: type
          uuid: uuid
          community_url: community_url
          lastname: lastname
          foreign_id: foreign_id
          community_id: community_id
          avatar_url: avatar_url
          updated_at: 2000-01-23T04:56:07.000+00:00
          mobile_phone: mobile_phone
          identity_group_id: identity_group_id
          company: company
          id: id
          screenname: screenname
          email: email
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Identity'
          type: array
    GetAllIdentityGroupsResponse:
      example:
        offset: 1
        records:
        - firstname: firstname
          tag_ids:
          - tag_ids
          - tag_ids
          notes: notes
          gender: gender
          identity_ids:
          - identity_ids
          - identity_ids
          created_at: 2000-01-23T04:56:07.000+00:00
          mobile_phones:
          - mobile_phones
          - mobile_phones
          lastname: lastname
          emails:
          - emails
          - emails
          home_phones:
          - home_phones
          - home_phones
          avatar_url: avatar_url
          custom_field_values: '{}'
          updated_at: 2000-01-23T04:56:07.000+00:00
          company: company
          id: id
        - firstname: firstname
          tag_ids:
          - tag_ids
          - tag_ids
          notes: notes
          gender: gender
          identity_ids:
          - identity_ids
          - identity_ids
          created_at: 2000-01-23T04:56:07.000+00:00
          mobile_phones:
          - mobile_phones
          - mobile_phones
          lastname: lastname
          emails:
          - emails
          - emails
          home_phones:
          - home_phones
          - home_phones
          avatar_url: avatar_url
          custom_field_values: '{}'
          updated_at: 2000-01-23T04:56:07.000+00:00
          company: company
          id: id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/IdentityGroup'
          type: array
    GetAllInterventionCommentsResponse:
      example:
        offset: 1
        records:
        - intervention_id: intervention_id
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          user_id: user_id
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          body: body
          videntity_id: videntity_id
        - intervention_id: intervention_id
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          user_id: user_id
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          body: body
          videntity_id: videntity_id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/InterventionComment'
          type: array
    GetAllInterventionsResponse:
      example:
        offset: 1
        records:
        - closed_at: 2000-01-23T04:56:07.000+00:00
          deferred_at: 2000-01-23T04:56:07.000+00:00
          content_id: content_id
          identity_id: identity_id
          custom_fields: '{}'
          created_at: 2000-01-23T04:56:07.000+00:00
          first_user_reply_in_bh: 2
          last_user_reply_in_bh: 9
          thread_id: thread_id
          first_user_reply_id: first_user_reply_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          last_user_reply_in: 7
          user_id: user_id
          comments_count: 5
          user_replies_count: 3
          closed: true
          first_user_reply_in: 5
          category_ids:
          - category_ids
          - category_ids
          id: id
          source_id: source_id
          user_reply_in_average_count: 7
          user_reply_in_average: 2
          status: status
          user_reply_in_average_bh: 4
        - closed_at: 2000-01-23T04:56:07.000+00:00
          deferred_at: 2000-01-23T04:56:07.000+00:00
          content_id: content_id
          identity_id: identity_id
          custom_fields: '{}'
          created_at: 2000-01-23T04:56:07.000+00:00
          first_user_reply_in_bh: 2
          last_user_reply_in_bh: 9
          thread_id: thread_id
          first_user_reply_id: first_user_reply_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          last_user_reply_in: 7
          user_id: user_id
          comments_count: 5
          user_replies_count: 3
          closed: true
          first_user_reply_in: 5
          category_ids:
          - category_ids
          - category_ids
          id: id
          source_id: source_id
          user_reply_in_average_count: 7
          user_reply_in_average: 2
          status: status
          user_reply_in_average_bh: 4
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Intervention'
          type: array
    GetAllPresenceStatusResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/PresenceStatus'
          type: array
    GetAllReplyAssistantEntriesResponse:
      example:
        offset: 1
        records:
        - foreign_id: foreign_id
          source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          entry_group_id: entry_group_id
          version_ids:
          - version_ids
          - version_ids
          shortcuts: shortcuts
          created_at: 2000-01-23T04:56:07.000+00:00
          category_ids:
          - category_ids
          - category_ids
          id: id
          label: label
        - foreign_id: foreign_id
          source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          entry_group_id: entry_group_id
          version_ids:
          - version_ids
          - version_ids
          shortcuts: shortcuts
          created_at: 2000-01-23T04:56:07.000+00:00
          category_ids:
          - category_ids
          - category_ids
          id: id
          label: label
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/ReplyAssistantEntry'
          type: array
    GetAllReplyAssistantGroupsResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          autocomplete: true
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          entry_ids:
          - entry_ids
          - entry_ids
          id: id
          position: 5
        - updated_at: 2000-01-23T04:56:07.000+00:00
          autocomplete: true
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          entry_ids:
          - entry_ids
          - entry_ids
          id: id
          position: 5
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/ReplyAssistantGroup'
          type: array
    GetAllReplyAssistantVersionsResponse:
      example:
        offset: 1
        records:
        - source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          format: text
          created_at: 2000-01-23T04:56:07.000+00:00
          language: language
          attachments_count: 5
          id: id
          body: body
          entry_id: entry_id
        - source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          format: text
          created_at: 2000-01-23T04:56:07.000+00:00
          language: language
          attachments_count: 5
          id: id
          body: body
          entry_id: entry_id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/ReplyAssistantVersion'
          type: array
    GetAllRolesResponse:
      example:
        offset: 1
        records:
        - manage_ice: true
          update_own_intervention: true
          author_block_content: true
          update_settings: true
          receive_tasks: true
          manage_reply_assistant: true
          access_previous_messages: true
          update_time_sheet: true
          read_presence: true
          search_event: true
          manage_folders: true
          id: id
          publish_content: true
          manage_custom_fields: true
          manage_topologies: true
          manage_chat: true
          invite_user: true
          read_community: true
          update_extension: true
          anonymize_identity: true
          manage_emails_templates: true
          export_identity: true
          update_content_source: true
          delay_export_content: true
          read_stats: true
          use_emoji: true
          manage_roles: true
          manage_own_notifications: true
          read_export: true
          open_content_thread: true
          monitor_team_tasks: true
          manage_teams: true
          manage_api_access_tokens: true
          create_user: true
          manage_custom_notifications: true
          update_identity: true
          update_community: true
          update_intervention: true
          reply_with_assistant: true
          created_at: 2000-01-23T04:56:07.000+00:00
          read_content_source: true
          use_cobrowsing: true
          impersonate_user: true
          manage_identities: true
          read_identity: true
          update_user: true
          manage_app_sdk_applications: true
          updated_at: 2000-01-23T04:56:07.000+00:00
          access_pull_mode: true
          create_content_source: true
          admin_stamp_answer: true
          approve_content: true
          delete_content_thread: true
          mute_content: true
          create_community: true
          monitor_tasks: true
          read_event: true
          manage_tags: true
          label: label
          manage_categories: true
          manage_users_of_my_teams: true
          lock_identity: true
          create_and_destroy_extension: true
          close_content_thread: true
          read_own_stats: true
          read_user: true
          access_help_center: true
          manage_messaging: true
          manage_rules_engine_rules: true
          assign_intervention: true
          search_contents: true
        - manage_ice: true
          update_own_intervention: true
          author_block_content: true
          update_settings: true
          receive_tasks: true
          manage_reply_assistant: true
          access_previous_messages: true
          update_time_sheet: true
          read_presence: true
          search_event: true
          manage_folders: true
          id: id
          publish_content: true
          manage_custom_fields: true
          manage_topologies: true
          manage_chat: true
          invite_user: true
          read_community: true
          update_extension: true
          anonymize_identity: true
          manage_emails_templates: true
          export_identity: true
          update_content_source: true
          delay_export_content: true
          read_stats: true
          use_emoji: true
          manage_roles: true
          manage_own_notifications: true
          read_export: true
          open_content_thread: true
          monitor_team_tasks: true
          manage_teams: true
          manage_api_access_tokens: true
          create_user: true
          manage_custom_notifications: true
          update_identity: true
          update_community: true
          update_intervention: true
          reply_with_assistant: true
          created_at: 2000-01-23T04:56:07.000+00:00
          read_content_source: true
          use_cobrowsing: true
          impersonate_user: true
          manage_identities: true
          read_identity: true
          update_user: true
          manage_app_sdk_applications: true
          updated_at: 2000-01-23T04:56:07.000+00:00
          access_pull_mode: true
          create_content_source: true
          admin_stamp_answer: true
          approve_content: true
          delete_content_thread: true
          mute_content: true
          create_community: true
          monitor_tasks: true
          read_event: true
          manage_tags: true
          label: label
          manage_categories: true
          manage_users_of_my_teams: true
          lock_identity: true
          create_and_destroy_extension: true
          close_content_thread: true
          read_own_stats: true
          read_user: true
          access_help_center: true
          manage_messaging: true
          manage_rules_engine_rules: true
          assign_intervention: true
          search_contents: true
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Role'
          type: array
    GetAllSourcesResponse:
      example:
        offset: 1
        records:
        - error_message: error_message
          sla_response: 7
          default_category_ids:
          - default_category_ids
          - default_category_ids
          color: 5
          default_content_language: default_content_language
          sla_expired_strategy: max
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          content_archiving: true
          content_languages:
          - content_languages
          - content_languages
          type: type
          auto_detect_content_language: true
          content_archiving_period: 5
          intervention_messages_boost: 2
          community_id: community_id
          time_sheet_ids:
          - time_sheet_ids
          - time_sheet_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          transferred_tasks_boost: 9
          name: name
          id: id
          channel_id: channel_id
          user_thread_default_category_ids:
          - user_thread_default_category_ids
          - user_thread_default_category_ids
          hidden_from_stats: true
          status: status
        - error_message: error_message
          sla_response: 7
          default_category_ids:
          - default_category_ids
          - default_category_ids
          color: 5
          default_content_language: default_content_language
          sla_expired_strategy: max
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          content_archiving: true
          content_languages:
          - content_languages
          - content_languages
          type: type
          auto_detect_content_language: true
          content_archiving_period: 5
          intervention_messages_boost: 2
          community_id: community_id
          time_sheet_ids:
          - time_sheet_ids
          - time_sheet_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          transferred_tasks_boost: 9
          name: name
          id: id
          channel_id: channel_id
          user_thread_default_category_ids:
          - user_thread_default_category_ids
          - user_thread_default_category_ids
          hidden_from_stats: true
          status: status
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Source'
          type: array
    GetAllTagsResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        - updated_at: 2000-01-23T04:56:07.000+00:00
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Tag'
          type: array
    GetAllTasksResponse:
      example:
        offset: 1
        records:
        - intervention_id: intervention_id
          content_id: content_id
          created_at: 2000-01-23T04:56:07.000+00:00
          transfered_at: 2000-01-23T04:56:07.000+00:00
          priority: 5
          accepted_at: 2000-01-23T04:56:07.000+00:00
          completed_at: 2000-01-23T04:56:07.000+00:00
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          locked_at: 2000-01-23T04:56:07.000+00:00
          expire_at: 2000-01-23T04:56:07.000+00:00
          step: step
          id: id
          channel_id: channel_id
          agent_ids:
          - agent_ids
          - agent_ids
        - intervention_id: intervention_id
          content_id: content_id
          created_at: 2000-01-23T04:56:07.000+00:00
          transfered_at: 2000-01-23T04:56:07.000+00:00
          priority: 5
          accepted_at: 2000-01-23T04:56:07.000+00:00
          completed_at: 2000-01-23T04:56:07.000+00:00
          thread_id: thread_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          locked_at: 2000-01-23T04:56:07.000+00:00
          expire_at: 2000-01-23T04:56:07.000+00:00
          step: step
          id: id
          channel_id: channel_id
          agent_ids:
          - agent_ids
          - agent_ids
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Task'
          type: array
    GetAllTeamsResponse:
      example:
        offset: 1
        records:
        - updated_at: 2000-01-23T04:56:07.000+00:00
          user_ids:
          - user_ids
          - user_ids
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          leader_ids:
          - leader_ids
          - leader_ids
        - updated_at: 2000-01-23T04:56:07.000+00:00
          user_ids:
          - user_ids
          - user_ids
          name: name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
          leader_ids:
          - leader_ids
          - leader_ids
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Team'
          type: array
    GetAllThreadsResponse:
      example:
        offset: 1
        records:
        - foreign_id: foreign_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          extra_data: '{}'
          interventions_count: 5
          thread_category_ids:
          - thread_category_ids
          - thread_category_ids
          closed: true
          created_at: 2000-01-23T04:56:07.000+00:00
          category_ids:
          - category_ids
          - category_ids
          id: id
          source_id: source_id
          title: title
          contents_count: 5
        - foreign_id: foreign_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          extra_data: '{}'
          interventions_count: 5
          thread_category_ids:
          - thread_category_ids
          - thread_category_ids
          closed: true
          created_at: 2000-01-23T04:56:07.000+00:00
          category_ids:
          - category_ids
          - category_ids
          id: id
          source_id: source_id
          title: title
          contents_count: 5
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Thread'
          type: array
    GetAllTimeSheetsResponse:
      example:
        offset: 1
        records:
        - saturday_hours: saturday_hours
          wednesday_hours: wednesday_hours
          thursday_hours: thursday_hours
          monday_hours: monday_hours
          timezone: timezone
          friday_hours: friday_hours
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          label: label
          sunday_hours: sunday_hours
          tuesday_hours: tuesday_hours
          source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          id: id
          holidays[]:
          - date: date
            name: name
          - date: date
            name: name
        - saturday_hours: saturday_hours
          wednesday_hours: wednesday_hours
          thursday_hours: thursday_hours
          monday_hours: monday_hours
          timezone: timezone
          friday_hours: friday_hours
          active: true
          created_at: 2000-01-23T04:56:07.000+00:00
          label: label
          sunday_hours: sunday_hours
          tuesday_hours: tuesday_hours
          source_ids:
          - source_ids
          - source_ids
          updated_at: 2000-01-23T04:56:07.000+00:00
          id: id
          holidays[]:
          - date: date
            name: name
          - date: date
            name: name
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/TimeSheet'
          type: array
    GetAllUsersResponse:
      example:
        offset: 1
        records:
        - firstname: firstname
          gender: gender
          identity_ids:
          - identity_ids
          - identity_ids
          team_ids:
          - team_ids
          - team_ids
          timezone: timezone
          created_at: 2000-01-23T04:56:07.000+00:00
          external_id: external_id
          locale: locale
          enabled: true
          invitation_pending: true
          lastname: lastname
          spoken_languages:
          - spoken_languages
          - spoken_languages
          rc_user_id: rc_user_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          role_id: role_id
          nickname: nickname
          category_ids:
          - category_ids
          - category_ids
          id: id
          email: email
        - firstname: firstname
          gender: gender
          identity_ids:
          - identity_ids
          - identity_ids
          team_ids:
          - team_ids
          - team_ids
          timezone: timezone
          created_at: 2000-01-23T04:56:07.000+00:00
          external_id: external_id
          locale: locale
          enabled: true
          invitation_pending: true
          lastname: lastname
          spoken_languages:
          - spoken_languages
          - spoken_languages
          rc_user_id: rc_user_id
          updated_at: 2000-01-23T04:56:07.000+00:00
          role_id: role_id
          nickname: nickname
          category_ids:
          - category_ids
          - category_ids
          id: id
          email: email
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/User'
          type: array
    GetAllWebhooksResponse:
      example:
        offset: 1
        records:
        - registered_events:
          - registered_events
          - registered_events
          staging_use: true
          active: true
          api_access_token:
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            id: id
          id: id
          verify_token: verify_token
          url: url
        - registered_events:
          - registered_events
          - registered_events
          staging_use: true
          active: true
          api_access_token:
            updated_at: 2000-01-23T04:56:07.000+00:00
            created_at: 2000-01-23T04:56:07.000+00:00
            id: id
          id: id
          verify_token: verify_token
          url: url
        count: 0
        limit: 6
      properties:
        count:
          format: int32
          type: integer
        limit:
          format: int32
          type: integer
        offset:
          format: int32
          type: integer
        records:
          items:
            $ref: '#/components/schemas/Webhook'
          type: array
    Identity:
      example:
        home_phone: home_phone
        firstname: firstname
        extra_values: '{}'
        gender: gender
        user_ids:
        - user_ids
        - user_ids
        created_at: 2000-01-23T04:56:07.000+00:00
        display_name: display_name
        type: type
        uuid: uuid
        community_url: community_url
        lastname: lastname
        foreign_id: foreign_id
        community_id: community_id
        avatar_url: avatar_url
        updated_at: 2000-01-23T04:56:07.000+00:00
        mobile_phone: mobile_phone
        identity_group_id: identity_group_id
        company: company
        id: id
        screenname: screenname
        email: email
      properties:
        avatar_url:
          type: string
        community_id:
          type: string
        community_url:
          type: string
        company:
          type: string
        created_at:
          format: date-time
          type: string
        display_name:
          type: string
        email:
          type: string
        extra_values:
          type: object
        firstname:
          type: string
        foreign_id:
          type: string
        gender:
          type: string
        home_phone:
          type: string
        id:
          type: string
        identity_group_id:
          description: The identity group id references the identity group that contains
            all informations (phone, notes, etc.). Many identities may belong to this
            group. If the identity group id is null, it means that identity does not
            have a group and any extra information. Please refer to identity groups
            API for more informations.
          type: string
        lastname:
          type: string
        mobile_phone:
          type: string
        screenname:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
        user_ids:
          items:
            type: string
          type: array
        uuid:
          type: string
    IdentityGroup:
      example:
        firstname: firstname
        tag_ids:
        - tag_ids
        - tag_ids
        notes: notes
        gender: gender
        identity_ids:
        - identity_ids
        - identity_ids
        created_at: 2000-01-23T04:56:07.000+00:00
        mobile_phones:
        - mobile_phones
        - mobile_phones
        lastname: lastname
        emails:
        - emails
        - emails
        home_phones:
        - home_phones
        - home_phones
        avatar_url: avatar_url
        custom_field_values: '{}'
        updated_at: 2000-01-23T04:56:07.000+00:00
        company: company
        id: id
      properties:
        avatar_url:
          type: string
        company:
          type: string
        created_at:
          format: date-time
          type: string
        custom_field_values:
          type: object
        emails:
          items:
            type: string
          type: array
        firstname:
          type: string
        gender:
          type: string
        home_phones:
          items:
            type: string
          type: array
        id:
          type: string
        identity_ids:
          items:
            type: string
          type: array
        lastname:
          type: string
        mobile_phones:
          items:
            type: string
          type: array
        notes:
          type: string
        tag_ids:
          items:
            type: string
          type: array
        updated_at:
          format: date-time
          type: string
      required:
      - id
    Intervention:
      example:
        closed_at: 2000-01-23T04:56:07.000+00:00
        deferred_at: 2000-01-23T04:56:07.000+00:00
        content_id: content_id
        identity_id: identity_id
        custom_fields: '{}'
        created_at: 2000-01-23T04:56:07.000+00:00
        first_user_reply_in_bh: 2
        last_user_reply_in_bh: 9
        thread_id: thread_id
        first_user_reply_id: first_user_reply_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        last_user_reply_in: 7
        user_id: user_id
        comments_count: 5
        user_replies_count: 3
        closed: true
        first_user_reply_in: 5
        category_ids:
        - category_ids
        - category_ids
        id: id
        source_id: source_id
        user_reply_in_average_count: 7
        user_reply_in_average: 2
        status: status
        user_reply_in_average_bh: 4
      properties:
        category_ids:
          items:
            type: string
          type: array
        closed:
          type: boolean
        closed_at:
          format: date-time
          type: string
        comments_count:
          type: integer
        content_id:
          type: string
        created_at:
          format: date-time
          type: string
        custom_fields:
          type: object
        deferred_at:
          format: date-time
          type: string
        first_user_reply_id:
          type: string
        first_user_reply_in:
          type: integer
        first_user_reply_in_bh:
          type: integer
        id:
          type: string
        identity_id:
          type: string
        last_user_reply_in:
          type: integer
        last_user_reply_in_bh:
          type: integer
        source_id:
          type: string
        status:
          type: string
        thread_id:
          type: string
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
        user_replies_count:
          type: integer
        user_reply_in_average:
          type: integer
        user_reply_in_average_bh:
          type: integer
        user_reply_in_average_count:
          type: integer
      required:
      - id
    InterventionComment:
      example:
        intervention_id: intervention_id
        thread_id: thread_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        user_id: user_id
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
        body: body
        videntity_id: videntity_id
      properties:
        body:
          type: string
        created_at:
          format: date-time
          type: string
        id:
          type: string
        intervention_id:
          type: string
        thread_id:
          type: string
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
        videntity_id:
          type: string
    Locale:
      example:
        code: code
        name: name
        interface: true
      properties:
        code:
          type: string
        interface:
          type: boolean
        name:
          type: string
    PresenceStatus:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
    ReplyAssistantEntry:
      example:
        foreign_id: foreign_id
        source_ids:
        - source_ids
        - source_ids
        updated_at: 2000-01-23T04:56:07.000+00:00
        entry_group_id: entry_group_id
        version_ids:
        - version_ids
        - version_ids
        shortcuts: shortcuts
        created_at: 2000-01-23T04:56:07.000+00:00
        category_ids:
        - category_ids
        - category_ids
        id: id
        label: label
      properties:
        category_ids:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        entry_group_id:
          type: string
        foreign_id:
          type: string
        id:
          type: string
        label:
          type: string
        shortcuts:
          type: string
        source_ids:
          items:
            type: string
          type: array
        updated_at:
          format: date-time
          type: string
        version_ids:
          items:
            type: string
          type: array
      required:
      - id
    ReplyAssistantGroup:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        autocomplete: true
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        entry_ids:
        - entry_ids
        - entry_ids
        id: id
        position: 5
      properties:
        autocomplete:
          type: boolean
        created_at:
          format: date-time
          type: string
        entry_ids:
          items:
            type: string
          type: array
        id:
          type: string
        name:
          type: string
        position:
          type: integer
        updated_at:
          format: date-time
          type: string
      required:
      - id
    ReplyAssistantVersion:
      example:
        source_ids:
        - source_ids
        - source_ids
        updated_at: 2000-01-23T04:56:07.000+00:00
        format: text
        created_at: 2000-01-23T04:56:07.000+00:00
        language: language
        attachments_count: 5
        id: id
        body: body
        entry_id: entry_id
      properties:
        attachments_count:
          type: integer
        body:
          type: string
        created_at:
          format: date-time
          type: string
        entry_id:
          type: string
        format:
          enum:
          - text
          - html
          type: string
        id:
          type: string
        language:
          type: string
        source_ids:
          items:
            type: string
          type: array
        updated_at:
          format: date-time
          type: string
      required:
      - id
    Restriction:
      example:
        only:
        - only
        - only
      properties:
        only:
          items:
            type: string
          type: array
    Role:
      example:
        manage_ice: true
        update_own_intervention: true
        author_block_content: true
        update_settings: true
        receive_tasks: true
        manage_reply_assistant: true
        access_previous_messages: true
        update_time_sheet: true
        read_presence: true
        search_event: true
        manage_folders: true
        id: id
        publish_content: true
        manage_custom_fields: true
        manage_topologies: true
        manage_chat: true
        invite_user: true
        read_community: true
        update_extension: true
        anonymize_identity: true
        manage_emails_templates: true
        export_identity: true
        update_content_source: true
        delay_export_content: true
        read_stats: true
        use_emoji: true
        manage_roles: true
        manage_own_notifications: true
        read_export: true
        open_content_thread: true
        monitor_team_tasks: true
        manage_teams: true
        manage_api_access_tokens: true
        create_user: true
        manage_custom_notifications: true
        update_identity: true
        update_community: true
        update_intervention: true
        reply_with_assistant: true
        created_at: 2000-01-23T04:56:07.000+00:00
        read_content_source: true
        use_cobrowsing: true
        impersonate_user: true
        manage_identities: true
        read_identity: true
        update_user: true
        manage_app_sdk_applications: true
        updated_at: 2000-01-23T04:56:07.000+00:00
        access_pull_mode: true
        create_content_source: true
        admin_stamp_answer: true
        approve_content: true
        delete_content_thread: true
        mute_content: true
        create_community: true
        monitor_tasks: true
        read_event: true
        manage_tags: true
        label: label
        manage_categories: true
        manage_users_of_my_teams: true
        lock_identity: true
        create_and_destroy_extension: true
        close_content_thread: true
        read_own_stats: true
        read_user: true
        access_help_center: true
        manage_messaging: true
        manage_rules_engine_rules: true
        assign_intervention: true
        search_contents: true
      properties:
        access_help_center:
          type: boolean
        access_previous_messages:
          type: boolean
        access_pull_mode:
          type: boolean
        admin_stamp_answer:
          type: boolean
        anonymize_identity:
          type: boolean
        approve_content:
          type: boolean
        assign_intervention:
          type: boolean
        author_block_content:
          type: boolean
        close_content_thread:
          type: boolean
        create_and_destroy_extension:
          type: boolean
        create_community:
          type: boolean
        create_content_source:
          type: boolean
        create_user:
          type: boolean
        created_at:
          format: date-time
          type: string
        delay_export_content:
          type: boolean
        delete_content_thread:
          type: boolean
        export_identity:
          type: boolean
        id:
          type: string
        impersonate_user:
          type: boolean
        invite_user:
          type: boolean
        label:
          type: string
        lock_identity:
          type: boolean
        manage_api_access_tokens:
          type: boolean
        manage_app_sdk_applications:
          type: boolean
        manage_categories:
          type: boolean
        manage_chat:
          type: boolean
        manage_custom_fields:
          type: boolean
        manage_custom_notifications:
          type: boolean
        manage_emails_templates:
          type: boolean
        manage_folders:
          type: boolean
        manage_ice:
          type: boolean
        manage_identities:
          type: boolean
        manage_messaging:
          type: boolean
        manage_own_notifications:
          type: boolean
        manage_reply_assistant:
          type: boolean
        manage_roles:
          type: boolean
        manage_rules_engine_rules:
          type: boolean
        manage_tags:
          type: boolean
        manage_teams:
          type: boolean
        manage_topologies:
          type: boolean
        manage_users_of_my_teams:
          type: boolean
        monitor_tasks:
          type: boolean
        monitor_team_tasks:
          type: boolean
        mute_content:
          type: boolean
        open_content_thread:
          type: boolean
        publish_content:
          type: boolean
        read_community:
          type: boolean
        read_content_source:
          type: boolean
        read_event:
          type: boolean
        read_export:
          type: boolean
        read_identity:
          type: boolean
        read_own_stats:
          type: boolean
        read_presence:
          type: boolean
        read_stats:
          type: boolean
        read_user:
          type: boolean
        receive_tasks:
          type: boolean
        reply_with_assistant:
          type: boolean
        search_contents:
          type: boolean
        search_event:
          type: boolean
        update_community:
          type: boolean
        update_content_source:
          type: boolean
        update_extension:
          type: boolean
        update_identity:
          type: boolean
        update_intervention:
          type: boolean
        update_own_intervention:
          type: boolean
        update_settings:
          type: boolean
        update_time_sheet:
          type: boolean
        update_user:
          type: boolean
        updated_at:
          format: date-time
          type: string
        use_cobrowsing:
          type: boolean
        use_emoji:
          type: boolean
    Settings:
      example:
        intervention_defer_threshold: 2
        password_non_word: true
        multi_lang: true
        activity_tracking: true
        rtl_support: true
        spellchecking: true
        timezone: timezone
        beginning_of_week: beginning_of_week
        created_at: 2000-01-23T04:56:07.000+00:00
        expire_password_after: 6
        locale: locale
        type: type
        sharding_key: sharding_key
        intervention_rates:
        - 7
        - 7
        updated_at: 2000-01-23T04:56:07.000+00:00
        password_min_length: 3
        password_numbers: true
        intervention_defer_rates:
        - 5
        - 5
        password_archivable_enabled: true
        browser_notifications_disabled: true
        dump_in_preprod: true
        id: id
        self_approval_required: true
        use_two_letters_avatars: true
        third_party_services_disabled: true
        disable_password_autocomplete: true
        deny_iframe_integration: true
        password_recovery_disabled: true
        urgent_task_threshold: 4
        activity_presence_threshold: 0
        fte_duration: 1
        push_enabled: true
        display_only_unknown_bbcode: true
        identity_merge: true
        name: name
        content_languages[]:
        - content_languages[]
        - content_languages[]
        style: style
        reply_as_any_identity: true
        password_archivable_size: 9
        session_timeout: 2
        expire_password_enabled: true
        intervention_closing_period: 5
      properties:
        activity_presence_threshold:
          type: integer
        activity_tracking:
          type: boolean
        beginning_of_week:
          type: string
        browser_notifications_disabled:
          type: boolean
        content_languages[]:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        deny_iframe_integration:
          type: boolean
        disable_password_autocomplete:
          type: boolean
        display_only_unknown_bbcode:
          type: boolean
        dump_in_preprod:
          type: boolean
        expire_password_after:
          type: integer
        expire_password_enabled:
          type: boolean
        fte_duration:
          type: integer
        id:
          type: string
        identity_merge:
          type: boolean
        intervention_closing_period:
          type: integer
        intervention_defer_rates:
          items:
            type: integer
          type: array
        intervention_defer_threshold:
          type: integer
        intervention_rates:
          items:
            type: integer
          type: array
        locale:
          type: string
        multi_lang:
          type: boolean
        name:
          type: string
        password_archivable_enabled:
          type: boolean
        password_archivable_size:
          type: integer
        password_min_length:
          type: integer
        password_non_word:
          type: boolean
        password_numbers:
          type: boolean
        password_recovery_disabled:
          type: boolean
        push_enabled:
          type: boolean
        reply_as_any_identity:
          type: boolean
        rtl_support:
          type: boolean
        self_approval_required:
          type: boolean
        session_timeout:
          type: integer
        sharding_key:
          type: string
        spellchecking:
          type: boolean
        style:
          type: string
        third_party_services_disabled:
          type: boolean
        timezone:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
        urgent_task_threshold:
          type: integer
        use_two_letters_avatars:
          type: boolean
    Source:
      example:
        error_message: error_message
        sla_response: 7
        default_category_ids:
        - default_category_ids
        - default_category_ids
        color: 5
        default_content_language: default_content_language
        sla_expired_strategy: max
        active: true
        created_at: 2000-01-23T04:56:07.000+00:00
        content_archiving: true
        content_languages:
        - content_languages
        - content_languages
        type: type
        auto_detect_content_language: true
        content_archiving_period: 5
        intervention_messages_boost: 2
        community_id: community_id
        time_sheet_ids:
        - time_sheet_ids
        - time_sheet_ids
        updated_at: 2000-01-23T04:56:07.000+00:00
        transferred_tasks_boost: 9
        name: name
        id: id
        channel_id: channel_id
        user_thread_default_category_ids:
        - user_thread_default_category_ids
        - user_thread_default_category_ids
        hidden_from_stats: true
        status: status
      properties:
        active:
          description: Activate/deactivate the source
          type: boolean
        auto_detect_content_language:
          description: Auto-detect content language (Boolean)
          type: boolean
        channel_id:
          type: string
        color:
          description: 'Color of the icon: Default: 0 Blue: 1 Green: 2 Turquoise:
            3 Purple: 4 Yellow: 5 Orange: 6 Red: 7 Asphalt: 8 Grey: 9'
          format: int32
          type: integer
        community_id:
          type: string
        content_archiving:
          description: Automatic archiving of old contents (Boolean)
          type: boolean
        content_archiving_period:
          description: Archive contents older than (seconds)
          format: int64
          type: integer
        content_languages:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        default_category_ids:
          description: Default categories
          items:
            type: string
          type: array
        default_content_language:
          description: Default content language
          type: string
        error_message:
          type: string
        hidden_from_stats:
          description: Hide from statistics
          type: boolean
        id:
          type: string
        intervention_messages_boost:
          description: Priority boost of messages with intervention
          format: int32
          type: integer
        name:
          description: Source name
          type: string
        sla_expired_strategy:
          description: SLA expired strategy ("max", "half" or "base")
          enum:
          - max
          - half
          - base
          type: string
        sla_response:
          description: Response time (seconds)
          format: int32
          type: integer
        status:
          type: string
        time_sheet_ids:
          items:
            type: string
          type: array
        transferred_tasks_boost:
          description: Priority boost of transferred tasks
          format: int32
          type: integer
        type:
          type: string
        updated_at:
          format: date-time
          type: string
        user_thread_default_category_ids:
          description: Default categories (agent messages)
          items:
            type: string
          type: array
    Tag:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
    Task:
      example:
        intervention_id: intervention_id
        content_id: content_id
        created_at: 2000-01-23T04:56:07.000+00:00
        transfered_at: 2000-01-23T04:56:07.000+00:00
        priority: 5
        accepted_at: 2000-01-23T04:56:07.000+00:00
        completed_at: 2000-01-23T04:56:07.000+00:00
        thread_id: thread_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        locked_at: 2000-01-23T04:56:07.000+00:00
        expire_at: 2000-01-23T04:56:07.000+00:00
        step: step
        id: id
        channel_id: channel_id
        agent_ids:
        - agent_ids
        - agent_ids
      properties:
        accepted_at:
          format: date-time
          type: string
        agent_ids:
          items:
            type: string
          type: array
        channel_id:
          type: string
        completed_at:
          format: date-time
          type: string
        content_id:
          type: string
        created_at:
          format: date-time
          type: string
        expire_at:
          format: date-time
          type: string
        id:
          type: string
        intervention_id:
          type: string
        locked_at:
          format: date-time
          type: string
        priority:
          type: integer
        step:
          type: string
        thread_id:
          type: string
        transfered_at:
          format: date-time
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
    Team:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        user_ids:
        - user_ids
        - user_ids
        name: name
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
        leader_ids:
        - leader_ids
        - leader_ids
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        leader_ids:
          items:
            type: string
          type: array
        name:
          type: string
        updated_at:
          format: date-time
          type: string
        user_ids:
          items:
            type: string
          type: array
      required:
      - id
    Thread:
      example:
        foreign_id: foreign_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        extra_data: '{}'
        interventions_count: 5
        thread_category_ids:
        - thread_category_ids
        - thread_category_ids
        closed: true
        created_at: 2000-01-23T04:56:07.000+00:00
        category_ids:
        - category_ids
        - category_ids
        id: id
        source_id: source_id
        title: title
        contents_count: 5
      properties:
        category_ids:
          items:
            type: string
          type: array
        closed:
          type: boolean
        contents_count:
          type: integer
        created_at:
          format: date-time
          type: string
        extra_data:
          type: object
        foreign_id:
          type: string
        id:
          type: string
        interventions_count:
          type: integer
        source_id:
          type: string
        thread_category_ids:
          items:
            type: string
          type: array
        title:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
    TimeSheet:
      example:
        saturday_hours: saturday_hours
        wednesday_hours: wednesday_hours
        thursday_hours: thursday_hours
        monday_hours: monday_hours
        timezone: timezone
        friday_hours: friday_hours
        active: true
        created_at: 2000-01-23T04:56:07.000+00:00
        label: label
        sunday_hours: sunday_hours
        tuesday_hours: tuesday_hours
        source_ids:
        - source_ids
        - source_ids
        updated_at: 2000-01-23T04:56:07.000+00:00
        id: id
        holidays[]:
        - date: date
          name: name
        - date: date
          name: name
      properties:
        active:
          type: boolean
        created_at:
          format: date-time
          type: string
        friday_hours:
          type: string
        holidays[]:
          items:
            $ref: '#/components/schemas/TimeSheetHoliday'
          type: array
        id:
          type: string
        label:
          type: string
        monday_hours:
          type: string
        saturday_hours:
          type: string
        source_ids:
          items:
            type: string
          type: array
        sunday_hours:
          type: string
        thursday_hours:
          type: string
        timezone:
          type: string
        tuesday_hours:
          type: string
        updated_at:
          format: date-time
          type: string
        wednesday_hours:
          type: string
      required:
      - id
    TimeSheetHoliday:
      example:
        date: date
        name: name
      properties:
        date:
          type: string
        name:
          type: string
    Timezone:
      example:
        utc_offset: ""
        name: ""
      properties:
        name:
          format: string
        utc_offset:
          format: integer
    User:
      example:
        firstname: firstname
        gender: gender
        identity_ids:
        - identity_ids
        - identity_ids
        team_ids:
        - team_ids
        - team_ids
        timezone: timezone
        created_at: 2000-01-23T04:56:07.000+00:00
        external_id: external_id
        locale: locale
        enabled: true
        invitation_pending: true
        lastname: lastname
        spoken_languages:
        - spoken_languages
        - spoken_languages
        rc_user_id: rc_user_id
        updated_at: 2000-01-23T04:56:07.000+00:00
        role_id: role_id
        nickname: nickname
        category_ids:
        - category_ids
        - category_ids
        id: id
        email: email
      properties:
        category_ids:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        email:
          type: string
        enabled:
          type: boolean
        external_id:
          type: string
        firstname:
          type: string
        gender:
          type: string
        id:
          type: string
        identity_ids:
          items:
            type: string
          type: array
        invitation_pending:
          type: boolean
        lastname:
          type: string
        locale:
          type: string
        nickname:
          type: string
        rc_user_id:
          type: string
        role_id:
          type: string
        spoken_languages:
          items:
            type: string
          type: array
        team_ids:
          items:
            type: string
          type: array
        timezone:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
    Webhook:
      example:
        registered_events:
        - registered_events
        - registered_events
        staging_use: true
        active: true
        api_access_token:
          updated_at: 2000-01-23T04:56:07.000+00:00
          created_at: 2000-01-23T04:56:07.000+00:00
          id: id
        id: id
        verify_token: verify_token
        url: url
      properties:
        active:
          type: boolean
        api_access_token:
          $ref: '#/components/schemas/WebhookAccessToken'
        id:
          type: string
        registered_events:
          items:
            type: string
          type: array
        staging_use:
          type: boolean
        url:
          type: string
        verify_token:
          type: string
      required:
      - id
    WebhookAccessToken:
      example:
        updated_at: 2000-01-23T04:56:07.000+00:00
        created_at: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http