Skip to main content
POST
/
api
/
v1
/
call
/
add_tags
curl -X POST 'https://app.reddy.io/api/v1/call/add_tags' \
  -H 'Authorization: Bearer your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "conversation_id": "12345",
    "agent_email": "[email protected]",
    "tags": [
      {
        "key": "customer_type",
        "value": "premium",
        "type": "string"
      },
      {
        "key": "satisfaction_score",
        "value": 5,
        "type": "integer"
      },
      {
        "key": "issue_resolved",
        "value": true,
        "type": "boolean"
      }
    ]
  }'

{
  "success": true
}
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.

​
Supported Data Types

  • string
  • integer
  • boolean
curl -X POST 'https://app.reddy.io/api/v1/call/add_tags' \
  -H 'Authorization: Bearer your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "conversation_id": "12345",
    "agent_email": "[email protected]",
    "tags": [
      {
        "key": "customer_type",
        "value": "premium",
        "type": "string"
      },
      {
        "key": "satisfaction_score",
        "value": 5,
        "type": "integer"
      },
      {
        "key": "issue_resolved",
        "value": true,
        "type": "boolean"
      }
    ]
  }'

{
  "success": true
}

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