Update enterprise settings

PATCH /settings
OAuth2

Update enterprise settings by their keys

Headers

  • Authorization string

    Bearer token used for authorization

    Minimum length is 1.

  • X-Correlation-Id string

    Unique identifier to allow referencing a particular transaction or event chain

    Minimum length is 1.

application/json

Body

  • * object Additional properties

    Additional properties are allowed.

    Hide * attributes Show * attributes object

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required
      Hide data attribute Show data attribute object
      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attributes Show * attributes object
  • 422 application/json

    Business validation failed

    • SETTING_APPOINTMENT_EARLIEST_LATEST_POSSIBLE_INVALID
    • SETTING_MANAGEABILITY_MODIFICATION_NOT_ALLOWED
    • SETTING_NON_MANAGEABLE
    • SETTING_VALUE_INVALID

    See Error codes

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.

      • arguments object | null

        Additional properties are allowed.
PATCH /settings 
curl \
 -X PATCH https://api.development.pexipengage.com/enterprises/acme/settings \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '{"additionalProperty1":{"manageable":true},"additionalProperty2":{"manageable":true}}'
Request examples 
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
{
  "additionalProperty1": {
    "manageable": true
  },
  "additionalProperty2": {
    "manageable": true
  }
}
Response examples (200) 
{
  "data": {
    "additionalProperty1": {
      "manageable": true,
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    },
    "additionalProperty2": {
      "manageable": true,
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    }
  }
}
Response examples (422) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}