Skip to main content
PATCH
Patch metadata

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

conversationId
string
required

Id of the conversation to update metadata for.

Body

application/json

Metadata key-value pairs.

The body is of type object.

Response

OK

statusCode
enum<string>
Available options:
SUCCESS,
ERROR
message
string