Update a country

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/countries/country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": {
      "description": "Antarctica"
    }
  }'

from exsited import build_client

client = build_client()

response = client.countries.update_settings_country(
    "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"country": {"description": "Antarctica"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.countries.updateSettingsCountry('country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    country: {description: 'Antarctica'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->countries->updateSettingsCountry('country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'country' => ['description' => 'Antarctica'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.countries.countries_dto.CountriesDto.SettingsCountry;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCountry> response = client.countries().updateSettingsCountry(
        "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("country", Map.of("description", "Antarctica")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Countries.UpdateSettingsCountryAsync(
    "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["country"] = new Dictionary<string, object?>
        {
            ["description"] = "Antarctica",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.countries.updateSettingsCountry(
  'country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'country': {'description': 'Antarctica'},
  },
);
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.Countries().UpdateSettingsCountry(context.Background(), "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"country": map[string]any{"description": "Antarctica"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "country": {
    "code": "<string>",
    "created_by": "<unknown>",
    "created_on": "<string>",
    "default_area_code": "<unknown>",
    "default_city": "<string>",
    "default_post_code": "<string>",
    "default_state": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "flag_exists": true,
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

PATCH

settings

countries

{country_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/countries/country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": {
      "description": "Antarctica"
    }
  }'

from exsited import build_client

client = build_client()

response = client.countries.update_settings_country(
    "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"country": {"description": "Antarctica"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.countries.updateSettingsCountry('country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    country: {description: 'Antarctica'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->countries->updateSettingsCountry('country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'country' => ['description' => 'Antarctica'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.countries.countries_dto.CountriesDto.SettingsCountry;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCountry> response = client.countries().updateSettingsCountry(
        "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("country", Map.of("description", "Antarctica")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Countries.UpdateSettingsCountryAsync(
    "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["country"] = new Dictionary<string, object?>
        {
            ["description"] = "Antarctica",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.countries.updateSettingsCountry(
  'country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'country': {'description': 'Antarctica'},
  },
);
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.Countries().UpdateSettingsCountry(context.Background(), "country_111b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"country": map[string]any{"description": "Antarctica"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "country": {
    "code": "<string>",
    "created_by": "<unknown>",
    "created_on": "<string>",
    "default_area_code": "<unknown>",
    "default_city": "<string>",
    "default_post_code": "<string>",
    "default_state": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "flag_exists": true,
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

Send the fields to change under country. You can change status, description and the default_* fields such as default_state and default_city. The response holds the country’s values from before the change, so read the country again to see what is stored.

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

country_id

string

required

The country's country_ id, as the listing returns it.

Body

application/json

country

object

required

Show child attributes

Response

200 - application/json

The country's values from before the change, under country.

country

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response