Update user role

Updates a user's role in the organization or profile. Requires admin role. You cannot change your own role or demote the last admin.

PATCH
/v3/users/{userId}

Path Parameters

userId*string

Header Parameters

Idempotency-Key?string

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

Match^[a-zA-Z0-9_-]+$
Lengthlength <= 255
x-profile-id?string

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.sent.dm/v3/users/string" \  -H "Idempotency-Key: req_abc123_retry1" \  -H "Content-Type: application/json" \  -d '{    "role": "billing",    "sandbox": false  }'
{
  "success": true,
  "data": {
    "id": "aa0e8400-e29b-41d4-a716-446655440005",
    "email": "user@example.com",
    "name": "User Name",
    "role": "billing",
    "status": "active",
    "invited_at": "2026-02-11T21:50:49.7855646+00:00",
    "last_login_at": "2026-03-11T16:50:49.7855657+00:00",
    "created_at": "2026-02-11T21:50:49.785566+00:00",
    "updated_at": "2026-03-11T21:50:49.7855661+00:00"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7855664+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Request validation failed",
    "details": {
      "role": [
        "Role must be one of: admin, billing, developer"
      ]
    },
    "doc_url": "https://docs.sent.dm/errors/VALIDATION_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7855707+00:00",
    "version": "v3"
  }
}
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "AUTH_004",
    "message": "You do not have admin access to this organization or profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/AUTH_004"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7855712+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_006",
    "message": "User not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/RESOURCE_006"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7855717+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred. Please contact support with request ID: req_7X9zKp2jDw",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7855734+00:00",
    "version": "v3"
  }
}

Invite a user POST

Sends an invitation to a user to join the organization or profile with a specific role. Requires admin role. The user will receive an invitation email with a token to accept. Invitation tokens expire after 7 days.

Remove user DELETE

Removes a user's access to an organization or profile. Requires admin role. You cannot remove yourself or remove the last admin.