Replace a conversation's metadata.

POST

/conversations/{conversation_id}

curl --request POST \
  --url https://api.helping.io/v1/conversations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": {} }'

metadata is required: this operation exists to set it. Send {} to clear the labels.

Authorizations

• api_key

Parameters

Path Parameters

conversation_id

required

string

The opaque conv_... id of the conversation

Request Body^required

The metadata to store.

Media typeapplication/json

Replace a conversation’s labels.

metadata is required: this operation exists to set it. Send {} to clear.

object

metadata

required

The labels to store, replacing whatever was there.

object

Example^generated

{
  "metadata": {}
}

Responses

200

The conversation, with its new metadata.

Media typeapplication/json

A conversation.

OpenAI requires all four fields, so none of them is optional here and none is skipped when empty. metadata in particular: a conversation with no labels answers with {}, never with the field absent.

object

created_at

required

When the conversation was created, in seconds since the Unix epoch.

integer format: int64

id

required

The conversation’s opaque id, conv_....

string

metadata

required

The customer’s own labels on this conversation.

object

object

required

Always conversation.

string

Example^generated

{
  "created_at": 1,
  "id": "example",
  "metadata": {},
  "object": "example"
}

400

Missing metadata, or metadata outside the documented limits (the error envelope)

401

Missing or invalid API key (the error envelope)

403

The key is not entitled to what the request asked for (the error envelope)

404

No such conversation, or one this key cannot reach.

409

The Idempotency-Key was already used and its result cannot be returned for this request, or its first request is still being processed (the error envelope)

429

This organization has exhausted its allowance; retry after the Retry-After header.

500

The request could not be completed; quote the x-request-id response header when reporting it.

503

The request could not be served this instant; retry after the Retry-After header.