Updates an organization

Updates an organization by the given id.

put

Path parameters

idstringRequired

The organization id.

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 request model for command requests related to organizations.

countryCodestring | nullableOptional

The country code of the organization.

Example: US

languageCodestring | nullableOptional

The language code of the organization.

Example: en

namestring | nullableOptional

The name of the organization.

Example: Organization Name

descriptionstring | nullableOptional

The description of the organization.

Example: Organization Description

avatarstring | nullableOptional

The avatar of the organization.

Example: https://example.com/avatar.png

isPrivateboolean | nullableOptional

The is private of the organization.

Example: true

isDefaultboolean | nullableOptional

The is default of the organization.

Example: true

statusstring · enumOptionalPossible values:

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

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

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

{
  "countryCode": "US",
  "languageCode": "en",
  "name": "Organization Name",
  "description": "Organization Description",
  "avatar": "https://example.com/avatar.png",
  "isPrivate": true,
  "isDefault": true,
  "status": "0 - Inactive"
}

application/jsontext/jsonapplication/*+json

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