Delete entity
Delete an entity associated with the specified entityId.
Deleting an entity will reset all resources that were linked to that entity to application = default and entity = null. You should ensure that any configuration (like resource associations, inbound message configurations, subscriptions, bots, API Keys etc) related to given entity are appropriately reassigned to other entities before attempting to delete the entity.
Authorizations:
Scopes:
Request rate limit:
path Parameters
| entityId required | string <= 255 characters Example: test-entity The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
curl -L -g -X DELETE 'https://{baseUrl}/provisioning/1/entities/test-entity' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 400
- 401
- 403
- 404
- 429
- 500
{- "requestError": {
- "serviceException": {
- "messageId": "BAD_REQUEST",
- "text": "Bad request"
}
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
