Skip to main content
POST
/
reference
/
agent
Create or update an external agent
curl --request POST \
  --url https://thalamus.nerds.nl/api/v1/reference/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "AGT-42",
  "name": "Jane Smith",
  "group_external_ids": [
    "GRP-100",
    "GRP-200"
  ]
}
'
{
  "success": true,
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "value": "<string>",
    "label": "<string>"
  },
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Partner API key (e.g. nerds_live_a8f3d9k2m5n7p1q4r6t8v0w2x4y6z8)

Body

application/json
​
external_id
string
required
Example:

"AGT-42"

​
name
string
required
Example:

"Jane Smith"

​
group_external_ids
string[]

List of group external_ids this agent belongs to

Example:
["GRP-100", "GRP-200"]

Response

Agent upserted

​
success
boolean
Example:

true

​
data
object
​
message
string