Updates users status in an organization

Updates the status of the user in the organization.

put

Path parameters

idstringRequired

The id of the organization.

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class represents the Organization User Join Request Data Transfer Object.

statusstring · enumRequiredPossible values:

userIdsstring[]Required

The list of user ids.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

404

The Organization was not found in the system.

application/json

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/organizations/{id}/users HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "status": "0 - Waiting",
  "userIds": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}