Delete a custom event

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/settings/custom_events/ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customEvents.deleteSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customEvents->deleteSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a');
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customEvents().deleteSettingsCustomEvent("ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomEvents.DeleteSettingsCustomEventAsync("ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customEvents.deleteSettingsCustomEvent(
  'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
);
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().DeleteSettingsCustomEvent(context.Background(), "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

DELETE

settings

custom_events

{custom_event_id}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/settings/custom_events/ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customEvents.deleteSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customEvents->deleteSettingsCustomEvent('ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a');
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customEvents().deleteSettingsCustomEvent("ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomEvents.DeleteSettingsCustomEventAsync("ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customEvents.deleteSettingsCustomEvent(
  'ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a',
);
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().DeleteSettingsCustomEvent(context.Background(), "ce_8b0d2f4a6c8e4b1d3f5a7c9e1b3d5f7a", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Returns 204 with no body. A custom event a workflow uses cannot be deleted. The messages its create added to the communication profiles stay behind.

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.

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.

Response

204

The custom event is deleted.

Guides

API reference

Authorizations

Path Parameters

Response