Skip to main content

Try the live demo!

Search

Update Conversation Custom Attributes

Returns 500 when the request body is not valid JSON.

PUT /api/v1/conversations/{uuid}/custom-attributes

Returns 500 when the request body is not valid JSON.

Authentication

Use an agent API key and secret.

Parameters

All parameters are path parameters. All parameters are required.

Name Type
uuid string

Request body

Custom attribute values

Required: Yes.

application/json

Field Type Required Description
body object Map of custom attribute keys to values. example: {"plan": "pro", "seats": 10}

Responses

200

Custom attributes updated successfully

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "success"
data boolean example: true

401

Unauthorized

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "error"
message string Error message example: "Invalid request"
data unspecified Additional error data nullable: true
error_type string (enum) enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"]

403

Permission denied

Content type: application/json.

Response fields match the 401 response.

404

Not found

Content type: application/json.

Response fields match the 401 response.

500

Internal server error

Content type: application/json.

Response fields match the 401 response.

Specification

Download the complete OpenAPI specification.

OpenAPI definition for this endpoint
openapi: 3.0.0
info:
  title: libredesk API
  description: >-
    REST API documentation for libredesk helpdesk system.


    ## Authentication


    The libredesk API supports two authentication methods:


    ### 1. Basic Authentication

    Use your API key and secret with Basic authentication:

    ```

    Authorization: Basic <base64_encoded_api_key:api_secret>

    ```


    ### 2. Token Authentication  

    Use your API key and secret with token authentication:

    ```

    Authorization: token api_key:api_secret

    ```


    To obtain API credentials, generate them from your agent profile in the
    libredesk dashboard.
  version: 1.0.0
servers:
  - url: http://localhost:8080
    description: Local development server
security:
  - basicAuth: []
  - tokenAuth: []
paths:
  /api/v1/conversations/{uuid}/custom-attributes:
    put:
      tags:
        - Conversations
      summary: Update Conversation Custom Attributes
      description: Returns 500 when the request body is not valid JSON.
      operationId: handleUpdateConversationCustomAttributes
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Custom attribute values
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAttributesUpdateRequest'
      responses:
        '200':
          description: Custom attributes updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - basicAuth: []
        - tokenAuth: []
components:
  schemas:
    CustomAttributesUpdateRequest:
      type: object
      additionalProperties: true
      description: Map of custom attribute keys to values.
      example:
        plan: pro
        seats: 10
    SuccessResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        data:
          type: boolean
          example: true
    ErrorResponse:
      type: object
      description: Error response format
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          description: Error message
          example: Invalid request
        data:
          nullable: true
          description: Additional error data
        error_type:
          type: string
          enum:
            - GeneralException
            - PermissionException
            - InputException
            - DataException
            - NetworkException
            - NotFoundException
            - ConflictException
            - UnauthorizedException
            - RateLimitException
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication using base64 encoded API key and secret. Format:
        `Authorization: Basic <base64(api_key:api_secret)>`
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        Token authentication using API key and secret. Format: `Authorization:
        token api_key:api_secret`

Was this article helpful?