Set Global Configuration

POST 
/properties/configurations/:configurationId/:newValue

Sets the global configuration value

Request

Path Parameters

configurationId stringrequired

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

newValue stringrequired

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": "newValue",
    "type": "string",
    "role": "configuration",
    "group": "account",
    "configurable": true,
    "scope": "global"
  }
}

Example

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

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...