PATCHRequires Bearer token

Assign a company role

/api/v1/users/{user}/role

Company-admin. company_role_id must belong to the same company.

Path parameters

Field	Type	Description
user Required	string	Path parameter `user`.

Query parameters

This endpoint has no query parameters.

Request body

Field	Type	Description
company_role_id Required	integer	Role id in the same company. e.g. 3

Responses

Status	Meaning
200	User role updated
401	Missing or invalid Bearer token.

Request

curl

curl -X PATCH 'https://api.dkbsigns.com/api/v1/users/user/role' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"company_role_id":3}'

Response 200

json

{
  "status": "success",
  "message": "User role updated",
  "data": {
    "id": 4,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "user@acme.test",
    "role": "user",
    "company_id": 1,
    "job_title": "Chief Financial Officer",
    "locale": "fr",
    "seal": null,
    "signature_mentions": {
      "enabled": true,
      "frame": false,
      "mentions": [
        "fullName",
        "jobTitle"
      ]
    },
    "is_available": true
  }
}