Update a configuration

Updates a configuration by the given id.

put

Path parameters

idstringRequired

The id of the configuration.

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 configuration data transfer object which is used to create or update a configuration.

groupCodestring · min: 1Required

The group code of the configuration.

codestring · min: 1Required

The code of the configuration.

namestring · min: 1Required

The name of the configuration.

valuestring · min: 1Required

The value of the configuration.

descriptionstring · nullableOptional

The description of the configuration.

statusstring · enumOptional

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

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/configurations/{id}

HTTPcURLJavaScriptPython

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

{
  "groupCode": "text",
  "code": "text",
  "name": "text",
  "value": "text",
  "description": "text",
  "status": "Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "groupCode": "GROUP_CODE",
    "code": "CODE",
    "name": "Name",
    "value": "Value",
    "description": "Description",
    "status": "Active",
    "isSystem": false
  },
  "errors": []
}