POpoll-the-people
Conversations

Update conversation.

Changed on

Updates conversation metadata, such as the display name. Use this to rename conversations for easier organization and identification.

put/api/v1/projects/{projectId}/conversations/{sessionId}

Request

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

sessionIdstring required

The unique session identifier.

Request body

namestring

The new name of the conversation

Example request

{
  "name": "My new conversation name"
}

Response

Update conversation information

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "created_at": "2023-04-30 16:43:53",
    "updated_at": "2023-04-30 16:43:53",
    "deleted_at": "2023-04-30 16:43:53",
    "id": 1,
    "name": "Conversation 1",
    "session_id": "f1b9aaf0-5e4e-11eb-ae93-0242ac130002"
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the non-success response with the status

  • b80e6dfcf78dRevision changes
    • warning

      added the new Agent id is required enum value to the / response property for the response status

    • warning

      added the new Agent with id {projectId} not found enum value to the / response property for the response status

    • info

      removed the Project id is required enum value from the / response property for the response status

    • info

      removed the Project with id {projectId} not found enum value from the / response property for the response status