Skip to main content

​
Integration Notes

  1. What Happens: The user access si restored, allowing them to sign in again.
  2. Use role defaults to member
  3. Authorization: Requires update:user scope.
  4. Idempotent: If the user is already enabled, the endpoint returns 200 with a message indicating the user is already enabled.

​
Request

No request body is required. Simply send a PUT request to the endpoint with the organization and user IDs in the path. 
PUT /v1/organizations/{organizationId}/users/{userId}/enable

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "statusCode": 200,
  "message": "User enabled successfully",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

​
Already Enabled (200 OK)

{
  "success": true,
  "statusCode": 200,
  "message": "User is already enabled",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

​
Response Fields

​
Success Response Data

FieldTypeDescription
user_idstringParchment’s unique user identifier

​
Common Response Fields

All responses include these standard fields:
FieldTypeDescription
successbooleanIndicates if the request was successful
statusCodenumberHTTP status code
timestampstringISO 8601 timestamp of the response
requestIdstringUnique identifier for debugging

​
Status Codes

CodeStatusDescription
200OKUser successfully enabled (or already enabled)
401UnauthorizedAuthentication required or token invalid
403ForbiddenInsufficient permissions (missing update:user scope)
404Not FoundUser not found
500Internal Server ErrorUnexpected server error