Override Global Configuration

PUT 
/org/:orgId/properties/configurations/:globalConfigurationId/:value

Create a new Organization Scoped Configuration with the value passed in.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

globalConfigurationId stringrequired

The Global Scope Configuration ID (non-UUID, human readable) for which you are querying.

value stringrequired

The Value you want to set the configuration to

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "account.host",
    "name": "account.host",
    "value": "value",
    "type": "string",
    "role": "configuration",
    "group": "account",
    "configurable": true,
    "scope": "local"
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "account.host",
    "name": "account.host",
    "value": "value",
    "type": "string",
    "role": "configuration",
    "group": "account",
    "configurable": true,
    "scope": "local"
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...