Create a communication profile

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/communication_profiles" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "communication_profile": {
      "name": "Wholesale notices"
    }
  }'

from exsited import build_client

client = build_client()

response = client.communication_profiles.create_settings_communication_profile(
    {"communication_profile": {"name": "Wholesale notices"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.createSettingsCommunicationProfile({
    communication_profile: {name: 'Wholesale notices'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communicationProfiles->createSettingsCommunicationProfile([
    'communication_profile' => ['name' => 'Wholesale notices'],
]);
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().createSettingsCommunicationProfile(
        Map.of("communication_profile", Map.of("name", "Wholesale notices")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CommunicationProfiles.CreateSettingsCommunicationProfileAsync(new Dictionary<string, object?>
{
    ["communication_profile"] = new Dictionary<string, object?>
    {
        ["name"] = "Wholesale notices",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .createSettingsCommunicationProfile({
      'communication_profile': {'name': 'Wholesale notices'},
    });
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().CreateSettingsCommunicationProfile(context.Background(), map[string]any{
	"communication_profile": map[string]any{"name": "Wholesale notices"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

settings

communication_profiles

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/communication_profiles" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "communication_profile": {
      "name": "Wholesale notices"
    }
  }'

from exsited import build_client

client = build_client()

response = client.communication_profiles.create_settings_communication_profile(
    {"communication_profile": {"name": "Wholesale notices"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.createSettingsCommunicationProfile({
    communication_profile: {name: 'Wholesale notices'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communicationProfiles->createSettingsCommunicationProfile([
    'communication_profile' => ['name' => 'Wholesale notices'],
]);
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().createSettingsCommunicationProfile(
        Map.of("communication_profile", Map.of("name", "Wholesale notices")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CommunicationProfiles.CreateSettingsCommunicationProfileAsync(new Dictionary<string, object?>
{
    ["communication_profile"] = new Dictionary<string, object?>
    {
        ["name"] = "Wholesale notices",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .createSettingsCommunicationProfile({
      'communication_profile': {'name': 'Wholesale notices'},
    });
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().CreateSettingsCommunicationProfile(context.Background(), map[string]any{
	"communication_profile": map[string]any{"name": "Wholesale notices"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send the profile under communication_profile. name is required. The new profile’s messages are copied from the profile named in copy_from, or from the default profile when copy_from is left out.

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.

Body

application/json

communication_profile

object

required

Show child attributes

Response

201

The new profile, under communication_profile.

Guides

API reference

Create a communication profile

Authorizations

Body

Response