Update agent

Update agent

curl --request PATCH \
  --url https://api.helpdesk.com/v1/agents/{agentID} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Text",
  "signature": {
    "text": "Best regards,\nJohn // Text, Inc.\n",
    "richTextObj": [
      {
        "type": "paragraph"
      },
      {
        "children": [
          {
            "text": "Best regards,"
          },
          {
            "type": "paragraph"
          },
          {
            "children": null
          },
          {
            "text": "Jogn // Text, Inc."
          }
        ]
      }
    ]
  },
  "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
  "roles": [
    "owner"
  ],
  "teamIDs": [
    "f56caf69-3f05-4386-9567-fdc909d7ad77"
  ],
  "flags": {
    "visitedWelcomeTutorial": true
  },
  "settings": {
    "emailNotificationsActive": true,
    "webpushNotificationsActive": "always"
  },
  "transactionID": "050340e4-82de-4a2a-a1c4-724dfaf66cec",
  "autoassignment": true,
  "autoassignmentTeamIDs": [
    "9dd9e888-b42e-46c1-aa63-20cb5354c28c"
  ]
}
'

import requests

url = "https://api.helpdesk.com/v1/agents/{agentID}"

payload = {
    "name": "John Text",
    "signature": {
        "text": "Best regards,
John // Text, Inc.
",
        "richTextObj": [{ "type": "paragraph" }, { "children": [{ "text": "Best regards," }, { "type": "paragraph" }, { "children": None }, { "text": "Jogn // Text, Inc." }] }]
    },
    "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
    "roles": ["owner"],
    "teamIDs": ["f56caf69-3f05-4386-9567-fdc909d7ad77"],
    "flags": { "visitedWelcomeTutorial": True },
    "settings": {
        "emailNotificationsActive": True,
        "webpushNotificationsActive": "always"
    },
    "transactionID": "050340e4-82de-4a2a-a1c4-724dfaf66cec",
    "autoassignment": True,
    "autoassignmentTeamIDs": ["9dd9e888-b42e-46c1-aa63-20cb5354c28c"]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Text',
    signature: {
      text: 'Best regards,\nJohn // Text, Inc.\n',
      richTextObj: [
        {type: 'paragraph'},
        {
          children: [
            {text: 'Best regards,'},
            {type: 'paragraph'},
            {children: null},
            {text: 'Jogn // Text, Inc.'}
          ]
        }
      ]
    },
    avatar: 'https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg',
    roles: ['owner'],
    teamIDs: ['f56caf69-3f05-4386-9567-fdc909d7ad77'],
    flags: {visitedWelcomeTutorial: true},
    settings: {emailNotificationsActive: true, webpushNotificationsActive: 'always'},
    transactionID: '050340e4-82de-4a2a-a1c4-724dfaf66cec',
    autoassignment: true,
    autoassignmentTeamIDs: ['9dd9e888-b42e-46c1-aa63-20cb5354c28c']
  })
};

fetch('https://api.helpdesk.com/v1/agents/{agentID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.helpdesk.com/v1/agents/{agentID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John Text',
    'signature' => [
        'text' => 'Best regards,
John // Text, Inc.
',
        'richTextObj' => [
                [
                                'type' => 'paragraph'
                ],
                [
                                'children' => [
                                                                [
                                                                                                                                'text' => 'Best regards,'
                                                                ],
                                                                [
                                                                                                                                'type' => 'paragraph'
                                                                ],
                                                                [
                                                                                                                                'children' => null
                                                                ],
                                                                [
                                                                                                                                'text' => 'Jogn // Text, Inc.'
                                                                ]
                                ]
                ]
        ]
    ],
    'avatar' => 'https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg',
    'roles' => [
        'owner'
    ],
    'teamIDs' => [
        'f56caf69-3f05-4386-9567-fdc909d7ad77'
    ],
    'flags' => [
        'visitedWelcomeTutorial' => true
    ],
    'settings' => [
        'emailNotificationsActive' => true,
        'webpushNotificationsActive' => 'always'
    ],
    'transactionID' => '050340e4-82de-4a2a-a1c4-724dfaf66cec',
    'autoassignment' => true,
    'autoassignmentTeamIDs' => [
        '9dd9e888-b42e-46c1-aa63-20cb5354c28c'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.helpdesk.com/v1/agents/{agentID}"

	payload := strings.NewReader("{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.helpdesk.com/v1/agents/{agentID}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpdesk.com/v1/agents/{agentID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
  "licenseID": 13381337,
  "createdAt": "2026-06-30T22:02:08.901Z",
  "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "createdByType": "agent",
  "updatedAt": "2026-06-30T22:02:08.901Z",
  "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "roles": [
    "owner"
  ],
  "teamIDs": [
    "f56caf69-3f05-4386-9567-fdc909d7ad77"
  ],
  "email": "john@helpdesk.com",
  "name": "John Text",
  "status": "active",
  "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
  "flags": {
    "visitedWelcomeTutorial": true
  },
  "settings": {
    "emailNotificationsActive": true,
    "webpushNotificationsActive": "always"
  },
  "autoassignment": true,
  "autoassignmentTeamIDs": [
    "9dd9e888-b42e-46c1-aa63-20cb5354c28c"
  ],
  "signature": {
    "text": "Best regards,\nJohn // Text, Inc.\n",
    "richTextObj": [
      {
        "type": "paragraph"
      },
      {
        "children": [
          {
            "text": "Best regards,"
          },
          {
            "type": "paragraph"
          },
          {
            "children": null
          },
          {
            "text": "Jogn // Text, Inc."
          }
        ]
      }
    ],
    "attachments": []
  }
}

PATCH

agents

{agentID}

Update agent

curl --request PATCH \
  --url https://api.helpdesk.com/v1/agents/{agentID} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Text",
  "signature": {
    "text": "Best regards,\nJohn // Text, Inc.\n",
    "richTextObj": [
      {
        "type": "paragraph"
      },
      {
        "children": [
          {
            "text": "Best regards,"
          },
          {
            "type": "paragraph"
          },
          {
            "children": null
          },
          {
            "text": "Jogn // Text, Inc."
          }
        ]
      }
    ]
  },
  "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
  "roles": [
    "owner"
  ],
  "teamIDs": [
    "f56caf69-3f05-4386-9567-fdc909d7ad77"
  ],
  "flags": {
    "visitedWelcomeTutorial": true
  },
  "settings": {
    "emailNotificationsActive": true,
    "webpushNotificationsActive": "always"
  },
  "transactionID": "050340e4-82de-4a2a-a1c4-724dfaf66cec",
  "autoassignment": true,
  "autoassignmentTeamIDs": [
    "9dd9e888-b42e-46c1-aa63-20cb5354c28c"
  ]
}
'

import requests

url = "https://api.helpdesk.com/v1/agents/{agentID}"

payload = {
    "name": "John Text",
    "signature": {
        "text": "Best regards,
John // Text, Inc.
",
        "richTextObj": [{ "type": "paragraph" }, { "children": [{ "text": "Best regards," }, { "type": "paragraph" }, { "children": None }, { "text": "Jogn // Text, Inc." }] }]
    },
    "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
    "roles": ["owner"],
    "teamIDs": ["f56caf69-3f05-4386-9567-fdc909d7ad77"],
    "flags": { "visitedWelcomeTutorial": True },
    "settings": {
        "emailNotificationsActive": True,
        "webpushNotificationsActive": "always"
    },
    "transactionID": "050340e4-82de-4a2a-a1c4-724dfaf66cec",
    "autoassignment": True,
    "autoassignmentTeamIDs": ["9dd9e888-b42e-46c1-aa63-20cb5354c28c"]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Text',
    signature: {
      text: 'Best regards,\nJohn // Text, Inc.\n',
      richTextObj: [
        {type: 'paragraph'},
        {
          children: [
            {text: 'Best regards,'},
            {type: 'paragraph'},
            {children: null},
            {text: 'Jogn // Text, Inc.'}
          ]
        }
      ]
    },
    avatar: 'https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg',
    roles: ['owner'],
    teamIDs: ['f56caf69-3f05-4386-9567-fdc909d7ad77'],
    flags: {visitedWelcomeTutorial: true},
    settings: {emailNotificationsActive: true, webpushNotificationsActive: 'always'},
    transactionID: '050340e4-82de-4a2a-a1c4-724dfaf66cec',
    autoassignment: true,
    autoassignmentTeamIDs: ['9dd9e888-b42e-46c1-aa63-20cb5354c28c']
  })
};

fetch('https://api.helpdesk.com/v1/agents/{agentID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.helpdesk.com/v1/agents/{agentID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John Text',
    'signature' => [
        'text' => 'Best regards,
John // Text, Inc.
',
        'richTextObj' => [
                [
                                'type' => 'paragraph'
                ],
                [
                                'children' => [
                                                                [
                                                                                                                                'text' => 'Best regards,'
                                                                ],
                                                                [
                                                                                                                                'type' => 'paragraph'
                                                                ],
                                                                [
                                                                                                                                'children' => null
                                                                ],
                                                                [
                                                                                                                                'text' => 'Jogn // Text, Inc.'
                                                                ]
                                ]
                ]
        ]
    ],
    'avatar' => 'https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg',
    'roles' => [
        'owner'
    ],
    'teamIDs' => [
        'f56caf69-3f05-4386-9567-fdc909d7ad77'
    ],
    'flags' => [
        'visitedWelcomeTutorial' => true
    ],
    'settings' => [
        'emailNotificationsActive' => true,
        'webpushNotificationsActive' => 'always'
    ],
    'transactionID' => '050340e4-82de-4a2a-a1c4-724dfaf66cec',
    'autoassignment' => true,
    'autoassignmentTeamIDs' => [
        '9dd9e888-b42e-46c1-aa63-20cb5354c28c'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.helpdesk.com/v1/agents/{agentID}"

	payload := strings.NewReader("{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.helpdesk.com/v1/agents/{agentID}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpdesk.com/v1/agents/{agentID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Text\",\n  \"signature\": {\n    \"text\": \"Best regards,\\nJohn // Text, Inc.\\n\",\n    \"richTextObj\": [\n      {\n        \"type\": \"paragraph\"\n      },\n      {\n        \"children\": [\n          {\n            \"text\": \"Best regards,\"\n          },\n          {\n            \"type\": \"paragraph\"\n          },\n          {\n            \"children\": null\n          },\n          {\n            \"text\": \"Jogn // Text, Inc.\"\n          }\n        ]\n      }\n    ]\n  },\n  \"avatar\": \"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg\",\n  \"roles\": [\n    \"owner\"\n  ],\n  \"teamIDs\": [\n    \"f56caf69-3f05-4386-9567-fdc909d7ad77\"\n  ],\n  \"flags\": {\n    \"visitedWelcomeTutorial\": true\n  },\n  \"settings\": {\n    \"emailNotificationsActive\": true,\n    \"webpushNotificationsActive\": \"always\"\n  },\n  \"transactionID\": \"050340e4-82de-4a2a-a1c4-724dfaf66cec\",\n  \"autoassignment\": true,\n  \"autoassignmentTeamIDs\": [\n    \"9dd9e888-b42e-46c1-aa63-20cb5354c28c\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
  "licenseID": 13381337,
  "createdAt": "2026-06-30T22:02:08.901Z",
  "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "createdByType": "agent",
  "updatedAt": "2026-06-30T22:02:08.901Z",
  "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "roles": [
    "owner"
  ],
  "teamIDs": [
    "f56caf69-3f05-4386-9567-fdc909d7ad77"
  ],
  "email": "john@helpdesk.com",
  "name": "John Text",
  "status": "active",
  "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
  "flags": {
    "visitedWelcomeTutorial": true
  },
  "settings": {
    "emailNotificationsActive": true,
    "webpushNotificationsActive": "always"
  },
  "autoassignment": true,
  "autoassignmentTeamIDs": [
    "9dd9e888-b42e-46c1-aa63-20cb5354c28c"
  ],
  "signature": {
    "text": "Best regards,\nJohn // Text, Inc.\n",
    "richTextObj": [
      {
        "type": "paragraph"
      },
      {
        "children": [
          {
            "text": "Best regards,"
          },
          {
            "type": "paragraph"
          },
          {
            "children": null
          },
          {
            "text": "Jogn // Text, Inc."
          }
        ]
      }
    ],
    "attachments": []
  }
}

Authorizations

Authorization

string

header

required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

agentID

string

required

Body

application/json

name

string

Full name

Example:

"John Text"

signature

object

Show child attributes

jobTitle

string

Job title

Example:

null

avatar

string

Avatar URL

Example:

"https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg"

roles

enum<string>[]

The agent's role on the license.

Available options:

owner,

normal,

viewer

teamIDs

string[]

List of teams that agent is a member of

flags

object

Show child attributes

settings

object

Show child attributes

transactionID

string<uuid>

The attachment transaction ID. Used when setting the signature that includes attachments.

autoassignment

boolean

Enable autoassignment for the agent

autoassignmentTeamIDs

string[]

List of teams from which an agent can be auto-assigned

Example:

["9dd9e888-b42e-46c1-aa63-20cb5354c28c"]

Response

200 - application/json

Successful response.

string<uuid>

Unique object identifier.

licenseID

integer

Unique account identifier.

createdAt

string<date-time>

The time of creation.

createdBy

string<uuid>

The creator identifier.

createdByType

enum<string>

The creator type.

Available options:

agent,

client,

system

updatedAt

string<date-time>

The time of last modification.

updatedBy

string<uuid>

The modification author identifier.

roles

enum<string>[]

Agent role

Available options:

owner,

normal,

viewer

teamIDs

string[]

A list of teams that agent is a member of.

string

The agent's email.

name

string

The full name.

status

enum<string>

The account status.

Available options:

active,

invited

avatar

string

The avatar URL.

jobTitle

string

The job title.

flags

object

Show child attributes

settings

object

Show child attributes

autoassignment

boolean

Enable autoassignment for the agent.

autoassignmentTeamIDs

string[]

A list of teams from which an agent can be auto-assigned.

signature

object

Show child attributes

Delete agent

List canned responses

Agents

Canned responses

Custom fields

Email domains

Mailboxes (inboxes)

Licenses

Reply addresses

Reports

Rules

Macros

Spam management

Tags

Teams

Templates

Audit log

Tickets

Transactions

Views

Webhooks

Imported tickets

Authorizations

Path Parameters

Body

Response