Update User | Apologist AI

Updates a user’s external_id and/or tags and upserts the persisted responder for the agent. Only provided fields are changed.

Authentication

x-api-keystring

API key for authentication

AuthorizationBearer

Bearer token authentication

Path parameters

user_idstringRequired

The user's external id or internal id

Request

This endpoint expects an object.

external_idstring or nullOptional<=100 characters

Your external identifier for the user.

tagslist of strings or integersOptional

Applied tags as a mix of existing tag ids and/or default-language tag names. Unknown ids or names are rejected. Tags are mirror-owned and never created here.

responder_idintegerOptional

Responder to persist for this user on the requesting agent. Must be active on the agent.

Response

The updated user

dataobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { ApologistAgentClient } from "apologist";
2
3	async function main() {
4	const client = new ApologistAgentClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.users.updateUser("user_id", {});
8	}
9	main();

1	{
2	"data": {
3	"id": "string",
4	"external_id": "string",
5	"team_id": 1,
6	"created_at": "string",
7	"migrated_at": "string",
8	"migrated_to_user_id": "string",
9	"tags": [
10	{
11	"id": 1,
12	"name": "string"
13	}
14	],
15	"responder_id": 1
16	}
17	}