Update a custom event

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/custom_events/ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_event": {
      "display_name": "Order approved by finance team"
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_events.update_settings_custom_event(
    "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
    {"custom_event": {"display_name": "Order approved by finance team"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customEvents.updateSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a', {
    custom_event: {display_name: 'Order approved by finance team'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customEvents->updateSettingsCustomEvent(
    'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
    ['custom_event' => ['display_name' => 'Order approved by finance team']],
);
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.customEvents().updateSettingsCustomEvent(
        "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
        Map.of("custom_event", Map.of("display_name", "Order approved by finance team")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomEvents.UpdateSettingsCustomEventAsync(
    "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
    new Dictionary<string, object?>
    {
        ["custom_event"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Order approved by finance team",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customEvents.updateSettingsCustomEvent(
  'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
  {
    'custom_event': {'display_name': 'Order approved by finance team'},
  },
);
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.CustomEvents().UpdateSettingsCustomEvent(context.Background(), "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a", map[string]any{
	"custom_event": map[string]any{
		"display_name": "Order approved by finance team",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

PATCH

settings

custom_events

{custom_event_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/custom_events/ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_event": {
      "display_name": "Order approved by finance team"
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_events.update_settings_custom_event(
    "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
    {"custom_event": {"display_name": "Order approved by finance team"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customEvents.updateSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a', {
    custom_event: {display_name: 'Order approved by finance team'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customEvents->updateSettingsCustomEvent(
    'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
    ['custom_event' => ['display_name' => 'Order approved by finance team']],
);
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.customEvents().updateSettingsCustomEvent(
        "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
        Map.of("custom_event", Map.of("display_name", "Order approved by finance team")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomEvents.UpdateSettingsCustomEventAsync(
    "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a",
    new Dictionary<string, object?>
    {
        ["custom_event"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Order approved by finance team",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customEvents.updateSettingsCustomEvent(
  'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
  {
    'custom_event': {'display_name': 'Order approved by finance team'},
  },
);
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.CustomEvents().UpdateSettingsCustomEvent(context.Background(), "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a", map[string]any{
	"custom_event": map[string]any{
		"display_name": "Order approved by finance team",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send the fields to change. The updated custom event comes back.

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

custom_event_id

string

required

The custom event's ce_ id.

Body

application/json

custom_event

object

required

The fields to change.

Show child attributes

Response

200

The updated custom event.

Guides

API reference

Authorizations

Path Parameters

Body

Response