Update Agent Alias

PUT

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

Overview

This endpoint updates the alias of a specific agent, allowing the user to assign a new unique identifier (usually in the form of an email) to the agent. It ensures that the alias is valid and updates the alias in the system, returning the complete list of aliases with updated details.

Functionality

Update Alias: Replaces the current alias of the agent with a new one provided in the request body.

Validation: Ensures that the new alias format is correct and that the specified agent exists.

Response with Full Alias Data: Returns all alias records after the update, including the alias just modified.

How to Find Your Agent ID

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///v2/api/agent/1251/alias' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alias": "PolicyWhisperer_1251-dev@ejento.ai"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Alias updated successfully",
    "data": [
        {
            "id": 1283,
            "agent_name": "SP Indexing 3",
            "alias": "SPIndexing3_1283-dev@ejento.ai",
            "project": {
                "id": 2,
                "created_by": "user@example.com",
                "created_on": "2024-01-23T16:49:01.320701Z",
                "modified_by": "zobia@example.com",
                "modified_on": "2024-09-09T22:39:02.737244Z",
                "project_name": "indexing",
                "team_visibility": false,
                "is_deleted": false,
                "team": 2
            }
        }
    ]
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Agent alias updated successfully.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Create Agent Alias

Delete Agent Alias

Update Agent Alias

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID