Skip to main content
PATCH
Update principal

Headers

X-API-Key
string | null

Path Parameters

principal_id
string<uuid>
required

The UUID of the principal to update. You can retrieve this value from the List all principals or List my agents operations.

Body

application/json

Request payload for updating a principal.

name
string
required

The new display name for this principal. Max 255 characters.

Required string length: 1 - 255

Response

Successful Response

result
PrincipalRead · object
required

Principal response payload.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object | null

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.