Skip to main content
POST
Check out our Add Call Metadata guide for examples of using this endpoint.
Adds tags (metadata) to a call for use in filters, QA, and reporting. Tags should be provided as a list of objects, each containing a key, value, and type. Note that this can fail either from the user not matching an active Reddy user or from failing the lookup of the conversation. Conversations are unique by the user and conversation ID together.
409 when two accounts share one address. agent_email is matched without regard to capitalisation, so Jane.Doe@Company.com and jane.doe@company.com reach the same agent. If more than one active user in your company holds that address, Reddy cannot tell them apart and will not guess: the request returns 409 with conflicting_user_ids, and nothing is recorded. Merge the duplicate accounts, then resend.

Supported Data Types

  • string
  • integer
  • boolean

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
conversation_id
string
required

Unique identifier for the conversation

agent_email
string
required

Email address of the agent handling the call

tags
Tag · object[]
required

Array of tag objects containing key, value, and type

Response

OK

Tags were successfully added to the call

success
boolean
required