PATCHRequires Bearer token

Activate or deactivate a user

/api/v1/users/{user}/status

Company-admin, same company. Reactivating consumes a license seat (403 SEAT_LIMIT_REACHED with limit and used).

Path parameters

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

Query parameters

This endpoint has no query parameters.

Request body

Field	Type	Description
active Required	boolean	Whether the user can sign in. e.g. true

Responses

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

Request

curl

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

Response 200

json

{
  "status": "success",
  "message": "User status 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,
    "active": true
  }
}