Skip to main content

Delete a key-value pair

Delete a key-value pair from the specified entity namespace.

  • entity: Entity namespace (user or event)
  • key: Key identifier

This operation is idempotent - it returns success even if the key doesn't exist. Returns whether the key was actually deleted.

Path Parameters
entity KVEntity REQUIRED

Possible values: [user, event]

Entity namespace types for KV storage

key Key REQUIRED
Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object

Response data for delete operation

entity KVEntity

Possible values: [user, event]

Entity namespace types for KV storage

key Key
deleted Deleted
default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.