Skip to main content
DELETE
cURL
The request must include the current etag. A stale value returns HTTP 409 Conflict; get the dictionary again before retrying the deletion. Set allowMissing=true when an already-absent dictionary should be treated as a successful deletion; a non-empty etag is still required.

Authorizations

Authorization
string
header
required

Your authentication credentials. For Basic authentication, send Basic $INWORLD_API_KEY. Use a Standard API key for the target workspace. Voices Read access permits list and get; Voices Write access permits all five methods.

Path Parameters

workspaceId
string
required

ID of the workspace that owns the dictionary. It must match a workspace accessible to the API key.

Required string length: 1 - 61
Pattern: ^[a-z0-9_-]+$
Example:

"my-workspace"

pronunciationDictionaryId
string<uuid>
required

Service-assigned UUID from the dictionary's resource name.

Example:

"2d470a1e-0262-4f22-9b46-5353d454d988"

Query Parameters

etag
string
required

Current dictionary etag from a get, list, create, or update response.

Minimum string length: 1
allowMissing
boolean
default:false

When true, deleting a dictionary that is already absent succeeds. A non-empty etag is still required, but it is not compared when the dictionary is absent.

Response

The dictionary was deleted.

The response is of type object.