Update a communication profile

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/communication_profiles/cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "communication_profile": {
      "display_name": "Wholesale notices",
      "description": "Messages for wholesale accounts"
    }
  }'

from exsited import build_client

client = build_client()

response = client.communication_profiles.update_settings_communication_profile(
    "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
    {
        "communication_profile": {
            "display_name": "Wholesale notices",
            "description": "Messages for wholesale accounts",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.updateSettingsCommunicationProfile(
    'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
    {communication_profile: {display_name: 'Wholesale notices', description: 'Messages for wholesale accounts'}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communicationProfiles->updateSettingsCommunicationProfile(
    'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
    [
        'communication_profile' => [
            'display_name' => 'Wholesale notices',
            'description' => 'Messages for wholesale accounts',
        ],
    ],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.communicationProfiles().updateSettingsCommunicationProfile(
        "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
        Map.of(
                "communication_profile", Map.of(
                        "display_name", "Wholesale notices",
                        "description", "Messages for wholesale accounts")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CommunicationProfiles.UpdateSettingsCommunicationProfileAsync(
    "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
    new Dictionary<string, object?>
    {
        ["communication_profile"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Wholesale notices",
            ["description"] = "Messages for wholesale accounts",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .updateSettingsCommunicationProfile(
      'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
      {
        'communication_profile': {
          'display_name': 'Wholesale notices',
          'description': 'Messages for wholesale accounts',
        },
      },
    );
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.CommunicationProfiles().UpdateSettingsCommunicationProfile(context.Background(), "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e", map[string]any{
	"communication_profile": map[string]any{
		"display_name": "Wholesale notices",
		"description":  "Messages for wholesale accounts",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

PATCH

settings

communication_profiles

{communication_profile_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/communication_profiles/cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "communication_profile": {
      "display_name": "Wholesale notices",
      "description": "Messages for wholesale accounts"
    }
  }'

from exsited import build_client

client = build_client()

response = client.communication_profiles.update_settings_communication_profile(
    "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
    {
        "communication_profile": {
            "display_name": "Wholesale notices",
            "description": "Messages for wholesale accounts",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.updateSettingsCommunicationProfile(
    'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
    {communication_profile: {display_name: 'Wholesale notices', description: 'Messages for wholesale accounts'}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communicationProfiles->updateSettingsCommunicationProfile(
    'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
    [
        'communication_profile' => [
            'display_name' => 'Wholesale notices',
            'description' => 'Messages for wholesale accounts',
        ],
    ],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.communicationProfiles().updateSettingsCommunicationProfile(
        "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
        Map.of(
                "communication_profile", Map.of(
                        "display_name", "Wholesale notices",
                        "description", "Messages for wholesale accounts")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CommunicationProfiles.UpdateSettingsCommunicationProfileAsync(
    "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e",
    new Dictionary<string, object?>
    {
        ["communication_profile"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Wholesale notices",
            ["description"] = "Messages for wholesale accounts",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .updateSettingsCommunicationProfile(
      'cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e',
      {
        'communication_profile': {
          'display_name': 'Wholesale notices',
          'description': 'Messages for wholesale accounts',
        },
      },
    );
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.CommunicationProfiles().UpdateSettingsCommunicationProfile(context.Background(), "cmp_7b2d9e4a1c6f4b8d9a3e5c1f2b4d6a8e", map[string]any{
	"communication_profile": map[string]any{
		"display_name": "Wholesale notices",
		"description":  "Messages for wholesale accounts",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send only the fields to change, under communication_profile. The profile comes back under communication_profile.

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

communication_profile_id

string

required

The communication profile's cmp_ id.

Body

application/json

communication_profile

object

required

Show child attributes

Response

200

The profile, under communication_profile.

Guides

API reference

Update a communication profile

Authorizations

Path Parameters

Body

Response