Update a service account
Settings module
PATCH/service-accounts/{id}serviceAccounts.update
A non-human member with its own audit identity. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability org.api_keys.manage.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the service account. |
Request body: ServiceAccountUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Service account name.Constraints: length 1 to 300 |
| owner_person_id | string (uuid) | No | Identifier of the owner. |
| expires_at | string (date-time) | null | No | Expiry. |
{
"name": "Ledger Export Bot",
"owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"expires_at": "2026-10-08T14:30:00Z"
}Response 200: ServiceAccount
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the service account. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Service account name.Constraints: length 1 to 300 |
| owner_person_id | string (uuid) | Yes | Identifier of the owner. |
| expires_at | string (date-time) | null | Yes | Expiry. |
| user_id | string (uuid) | Yes | Identifier of the sign-in of the service account, which never signs in interactively. |
| person_id | string (uuid) | Yes | Identifier of the person row of the service account, the actor in audit columns. |
| membership_id | string (uuid) | Yes | Identifier of the membership that carries the service account's role in the org. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Ledger Export Bot",
"owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"expires_at": "2026-10-08T14:30:00Z",
"user_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X PATCH "$XOS_BASE_URL/service-accounts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"name":"Ledger Export Bot","owner_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","expires_at":"2026-10-08T14:30:00Z"}'const { data, etag } = await xos.serviceAccounts.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"name": "Ledger Export Bot",
"owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"expires_at": "2026-10-08T14:30:00Z"
}, { ifMatch: etag });response = xos.service_accounts.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Ledger Export Bot", "owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "expires_at": "2026-10-08T14:30:00Z"}, if_match=etag)xos service-accounts update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Ledger Export Bot","owner_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","expires_at":"2026-10-08T14:30:00Z"}' --if-match auto