Updates an organization

Updates an organization by the given id.

put

Path parameters

idstringRequired

The organization id.

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 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 · min: 1Required

The name of the organization.

Example: Organization Name

descriptionstring · min: 1Required

The description of the organization.

Example: Organization Description

avatarstring · uri | nullableOptional

The avatar of the organization.

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

isPrivateboolean | nullableOptional

The is private of the organization. By default, it is set to false.

Example: true

isDefaultboolean | nullableOptional

The is default of the organization. By default, it is set to false.

Example: true

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

Possible 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 Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

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