Delete an object definition
Learn more about how to delete the configuration definition for a specific object using the Configuration API.
Use the Configuration to delete the configuration definition for a specific type within a supported object type. This operation requires DELETE access for the specified type. You can delete the object definition only if it exists and is not in use.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
DELETE {TenantURL}/configuration/{objectType}/{typeName}
The following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| objectType | Yes, for the general object type endpoint | The configuration object type that contains the definition to delete. Supported values for this endpoint are entityTypes, groupTypes, relationTypes, graphTypes, interactionTypes, changeRequestTypes and categoryTypes. This endpoint does not support sources. |
| typeName | Yes | The name of the specific type definition to delete. |
Request headers
Include the following header in the request.
| Name | Required | Description |
|---|---|---|
| Authorization | Yes | Access token used to authenticate the tenant request. |
Example request
The following example deletes the Individual entity type definition.
DELETE {TenantURL}/configuration/entityTypes/Individual
Authorization: <access_token>Example response
The following examples show the response pattern for successful and error outcomes.
Successful response
HTTP/1.1 204 No ContentError response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<TYPE_IS_NOT_FOUND>