Update an object definition
Learn more about how to use the Configuration API to update a configuration definition for a specific object type.
Use the Configuration to update the configuration definition for a specific type within a supported object type. This operation requires UPDATE access for the specified type and can update a definition only when inheritance is disabled for that type.
HTTP method and endpoint
Use the following HTTP method and endpoint path for the Configuration API request:
PUT {TenantURL}/configuration/{objectType}/{typeName}
The following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL for your tenant. |
| objectType | Yes, for the general object type endpoint | The configuration object type that contains the definition to update. Supported values for this endpoint are entityTypes, groupTypes, relationTypes, graphTypes, interactionTypes, changeRequestTypes, and categoryTypes. This endpoint does not support sources.Note: Only one changeRequestType can be configured at a time. |
| typeName | Yes | The name of the specific type definition to update. |
Request headers
Include the following headers in the request.
| Name | Required | Description |
|---|---|---|
| Authorization | Yes | Access token used to authenticate the tenant request. |
| Content-Type | Yes | application/json |
Example request
The following example updates the Individual entity type.
PUT {TenantURL}/configuration/entityTypes/Individual
Authorization: <access_token>
Content-Type: application/json
<updated configuration definition for the Individual entity type>Example response
The exact response payload depends on the requested object type and the updated definition. The following examples show the response pattern for successful and error outcomes.
Successful response
HTTP/1.1 200 OK
Content-Type: application/json
<updated configuration definition>Error response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<VALIDATION_ERROR or TYPE_IS_NOT_FOUND>