Update a variation

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/variations/1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "variation": {
      "display_name": "Size",
      "description": "Clothing sizes"
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_variation(
    "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"variation": {"display_name": "Size", "description": "Clothing sizes"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsVariation('1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    variation: {display_name: 'Size', description: 'Clothing sizes'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsVariation('1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'variation' => ['display_name' => 'Size', 'description' => 'Clothing sizes'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsVariations;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsVariations> response = client.settings().updateSettingsVariation(
        "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("variation", Map.of("display_name", "Size", "description", "Clothing sizes")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsVariationAsync(
    "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["variation"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Size",
            ["description"] = "Clothing sizes",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsVariation(
  '1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'variation': {'display_name': 'Size', 'description': 'Clothing sizes'},
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Settings().UpdateSettingsVariation(context.Background(), "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"variation": map[string]any{
		"display_name": "Size",
		"description":  "Clothing sizes",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "variation": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "options": "<array>",
    "status": "<string>",
    "uuid": "<string>"
  }
}

PATCH

settings

variations

{variation_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/variations/1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "variation": {
      "display_name": "Size",
      "description": "Clothing sizes"
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_variation(
    "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"variation": {"display_name": "Size", "description": "Clothing sizes"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsVariation('1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    variation: {display_name: 'Size', description: 'Clothing sizes'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsVariation('1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'variation' => ['display_name' => 'Size', 'description' => 'Clothing sizes'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsVariations;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsVariations> response = client.settings().updateSettingsVariation(
        "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("variation", Map.of("display_name", "Size", "description", "Clothing sizes")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsVariationAsync(
    "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["variation"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Size",
            ["description"] = "Clothing sizes",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsVariation(
  '1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'variation': {'display_name': 'Size', 'description': 'Clothing sizes'},
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Settings().UpdateSettingsVariation(context.Background(), "1d1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"variation": map[string]any{
		"display_name": "Size",
		"description":  "Clothing sizes",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "variation": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "options": "<array>",
    "status": "<string>",
    "uuid": "<string>"
  }
}

Send the fields to change under variation, such as display_name and description.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

variation_id

string

required

The variation's id, as a listing or a create returns it.

Body

application/json

variation

object

required

Show child attributes

Response

200 - application/json

The updated variation, under variation.

variation

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response