Updates users status in an organization

Updates the status of the user in the organization.

put

Path parameters

organizationIdstringRequired

The id of the organization.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

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

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

databooleanRead-onlyOptional

This is the data to be returned to the client.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

404

The organization was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/organizations/{organizationId}/users

HTTPcURLJavaScriptPython

PUT /api/v1/organizations/{organizationId}/users HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 39

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

application/jsontext/jsonapplication/*+json

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