PIpipeshub-ai
Conversations

Update conversation title

Changed on

Update the title of a conversation.

Overview:

Conversation titles are auto-generated from the first query by default. Use this endpoint to set a custom, more descriptive title.

Title limits:

  • Minimum: 1 character
  • Maximum: 200 characters

Permissions:

The conversation must exist, belong to the calling user's organization, be owned by the caller (matched on userId), not be soft-deleted, and not be an agent conversation. A user it is shared with, even at write access, gets 404.

Body fields other than title are dropped by the validator, not refused.

patch/conversations/{conversationId}/title

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/{conversationId}/title
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: conversation:write

Path parameters

conversationIdstring objectId required

Unique conversation identifier

Request body

titlestring required

New conversation title. Surrounding whitespace is trimmed before validation, so a title of only whitespace is refused with 400 VALIDATION_ERROR ("Title is required").

Example request

{
  "title": "Q4 Sales Analysis Discussion"
}

Response

Title updated successfully

Changes

  • dbb5e203b445Revision changes
    • breaking

      added the pattern \S to the request property

    • info

      added the media type application/x-www-form-urlencoded to the request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

  • bb0c59adf026Revision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      added the new Stopped enum value to the / response property for the response status