Update Setting Slug

Production

PUT

https://api.salla.dev/admin/v2/settings/fields/{slug}

Settings

Last modified:2025-02-02 12:23:10

This endpoint allows you to update a specific Setting slug based on a specific entity, where the payload will be changed based on the passed body parameter values

For more on Store Settings, check the Merchant's Help Desk article here

Scopes

store-settings.read_write- Settings Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

slug

string

required

Unique identifier or URL-friendly name assigned to the Settings . Get a list of Settings Slugs from here

Body Params application/json

value

optional

Required if entity type value is either: boolean, string, or dropdown

Any of

boolean

string

array[string]

Send the boolean variable if the entity value type is set to boolean

Example

{
  "value": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.salla.dev/admin/v2/settings/fields/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "value": true
}'

Responses

🟢201Created

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

code

number

optional

A numerical or alphanumeric identifier used in various systems and protocols to indicate the status or outcome of a specific request.

Example

{
  "status": 201,
  "success": true,
  "data": {
    "message": "The record has been updated successfully",
    "code": 201
  }
}

🟠404error_notFound_404

🟠401Unauthorized

Modified at 2025-02-02 12:23:10

Settings List

Setting Details