Create Agent Alias

POST

/v2/api/agent/{agent_id}/alias

Overview

This endpoint allows you to create a new alias for a specific agent using the provided agent_id.
An alias typically follows an email-style format, allowing it to be used easily in communication workflows, or internal identification mechanisms.

Functionality

Accepts a request body containing the new alias in an email-like format.

The alias is associated with the agent identified by the agent_id provided in the URL path.

Once the alias is successfully created, the response includes all aliases for that agent along with associated project metadata.

How to Find Your Agent ID

If you're unsure about the agent_id, follow this guide:
How to View Agent ID

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Agent alias created successfully.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/agent/0/alias' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alias": "[email protected]"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Alias Created successfully",
    "data": [
        {
            "id": 5,
            "agent_name": "New Agent3",
            "alias": "[email protected]",
            "project": {
                "id": 1,
                "created_by": "[email protected]",
                "created_on": "2024-11-12T01:31:30.341415Z",
                "modified_by": "",
                "modified_on": "2024-11-12T01:31:30.341415Z",
                "project_name": "Social Media",
                "team_visibility": false,
                "is_deleted": false,
                "team": 1
            }
        }
    ]
}

Get All Agent Aliases

Update Agent Alias

Create Agent Alias

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID