Agent Details Management

These endpoints allow for the retrieval and modification of granular agent data, including organizational roles and personal contact information.

Get Agent Details

GET /Advanced Dialer/api/agent/{userId}/details

Returns comprehensive AgentDetailed information, including personal and user-level system data.

Path Parameters

Parameter	Type	Description
`userId`	integer	The unique identifier of the agent.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/agent/1001/details' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": {
    "id": 1001,
    "username": "john.smith",
    "title": "Senior Agent",
    "firstName": "John",
    "lastName": "Smith",
    "isActive": true,
    "unlocked": true,
    "dateOfBirth": "1985-06-15T00:00:00Z",
    "userInformation": {
      "homeTeam": {
        "id": 5,
        "name": "Sales Team"
      },
      "passwordExpiry": "2024-12-31T23:59:59Z",
      "role": {
        "id": 2,
        "name": "Agent"
      },
      "teamLeader": "sarah.johnson",
      "isActiveDirectory": false
    },
    "personalInformation": {
      "email": "[email protected]",
      "home": "+1-555-0199",
      "mobile": "+1-555-0123",
      "address": {
        "addressLine1": "456 Oak Avenue",
        "addressLine2": "Apt 2B",
        "postcode": "54321"
      }
    }
  }
}

Update Agent Details

PUT /Advanced Dialer/api/agent/{userId}/details

Updates specific agent fields. This endpoint supports partial updates for the objects provided.

Path Parameters

Parameter	Type	Description
`userId`	integer	The unique identifier of the agent to update.

Request Body

Field	Type	Description
`title`	string	New job title for the agent.
`personalInformation`	object	Nested object containing mobile and address updates.

Example Request

curl --request PUT \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/agent/1001/details' \
     --header 'Content-Type: application/json' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0' \
     --data '
{
  "title": "Senior Customer Success Agent",
  "personalInformation": {
    "mobile": "+1-555-9999",
    "address": {
      "addressLine1": "789 New Street",
      "addressLine2": "Floor 3",
      "postcode": "67890"
    }
  }
}'