Update a salutation

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/salutations/1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "salutation": {
      "display_name": "Doctor",
      "description": "Medical or academic title"
    }
  }'

from exsited import build_client

client = build_client()

response = client.salutations.update_settings_salutation(
    "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "salutation": {
            "display_name": "Doctor",
            "description": "Medical or academic title",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.salutations.updateSettingsSalutation('1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    salutation: {display_name: 'Doctor', description: 'Medical or academic title'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->salutations->updateSettingsSalutation('1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'salutation' => ['display_name' => 'Doctor', 'description' => 'Medical or academic title'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.salutations.salutations_dto.SalutationsDto.SettingsSalutation;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsSalutation> response = client.salutations().updateSettingsSalutation(
        "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "salutation", Map.of(
                        "display_name", "Doctor",
                        "description", "Medical or academic title")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Salutations.UpdateSettingsSalutationAsync(
    "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["salutation"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Doctor",
            ["description"] = "Medical or academic title",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.salutations.updateSettingsSalutation(
  '1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'salutation': {
      'display_name': 'Doctor',
      'description': 'Medical or academic title',
    },
  },
);
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.Salutations().UpdateSettingsSalutation(context.Background(), "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"salutation": map[string]any{
		"display_name": "Doctor",
		"description":  "Medical or academic title",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "salutation": {
    "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>",
    "status": "<string>"
  }
}

PATCH

settings

salutations

{salutation_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/salutations/1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "salutation": {
      "display_name": "Doctor",
      "description": "Medical or academic title"
    }
  }'

from exsited import build_client

client = build_client()

response = client.salutations.update_settings_salutation(
    "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "salutation": {
            "display_name": "Doctor",
            "description": "Medical or academic title",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.salutations.updateSettingsSalutation('1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    salutation: {display_name: 'Doctor', description: 'Medical or academic title'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->salutations->updateSettingsSalutation('1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'salutation' => ['display_name' => 'Doctor', 'description' => 'Medical or academic title'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.salutations.salutations_dto.SalutationsDto.SettingsSalutation;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsSalutation> response = client.salutations().updateSettingsSalutation(
        "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "salutation", Map.of(
                        "display_name", "Doctor",
                        "description", "Medical or academic title")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Salutations.UpdateSettingsSalutationAsync(
    "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["salutation"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Doctor",
            ["description"] = "Medical or academic title",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.salutations.updateSettingsSalutation(
  '1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'salutation': {
      'display_name': 'Doctor',
      'description': 'Medical or academic title',
    },
  },
);
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.Salutations().UpdateSettingsSalutation(context.Background(), "1c1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"salutation": map[string]any{
		"display_name": "Doctor",
		"description":  "Medical or academic title",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "salutation": {
    "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>",
    "status": "<string>"
  }
}

Send the fields to change under salutation.

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

salutation_id

string

required

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

Body

application/json

salutation

object

required

Show child attributes

Response

200 - application/json

The updated salutation, under salutation.

salutation

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response