Skip to main content
DELETE
Delete a value

Authorizations

Authorization
string
header
required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Headers

Idempotency-Key
string

Makes a write safe to retry: the same key with the same method, path, query and body within 24 hours answers the stored result (Idempotent-Replayed: true) without running the write again. Only a successful answer is stored, so a retry after a failure runs. A key reused for a different request is 422 IDEMPOTENCY_KEY_REUSED; one whose first request still runs is 409 IDEMPOTENCY_KEY_IN_USE.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Path Parameters

ownerType
enum<string>
required

What the value is kept on. Another word is 400 VALIDATION_FAILED.

Available options:
business,
store,
product,
order,
customer
ownerId
string
required

The owner's id (for business, the business id). An owner this installation cannot read, or a malformed id, is 404 NOT_FOUND; a store outside the installation's stores is 460 STORE_SCOPE_FORBIDDEN.

Minimum string length: 1
key
string
required

A key the manifest declares for the owner type ([[data.definitions]]). A malformed one is 400 VALIDATION_FAILED.

Pattern: ^[a-z][a-z0-9_]{0,63}$

Response

Deleted.

data
object
required

What a delete answers: the id, and that it is gone.