Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

1.6 KB
Raw Blame
tags:
  - Conversations
operationId: update-custom-attributes-of-a-conversation
summary: Update Custom Attributes
description: Updates the custom attributes of a conversation
security:
  - userBearerAuth: []
  - agentBotBearerAuth: []
  - userApiKey: []
requestBody:
  required: true
  content:
    application/json:
      schema:
        type: object
        required:
          - custom_attributes
        properties:
          custom_attributes:
            type: object
            description: The custom attributes to be set for the conversation
            example:
              order_id: '12345'
              previous_conversation: '67890'
          merge:
            type: boolean
            default: false
            description: >-
              When true, only the keys sent in `custom_attributes` are updated and the remaining
              keys are kept intact. When false (default), the whole custom attributes hash is
              replaced. Use the destroy_custom_attributes endpoint to remove keys.
responses:
  '200':
    description: Success
    content:
      application/json:
        schema:
          type: object
          properties:
            custom_attributes:
              type: object
              description: The custom attributes of the conversation
  '401':
    description: Unauthorized
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/bad_request_error'
  '404':
    description: Conversation not found
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/bad_request_error'