Recipe Covers

Archive a recipe cover candidate

delete/api/v1/recipes/{id}/covers/{coverId}

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/recipes/{id}/covers/{coverId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __session
    • OAuth 2 (authorization code, authorization URL https://spoonjoy.app/oauth/authorize, token URL https://spoonjoy.app/oauth/token, scopes: kitchen:write)

Path parameters

idstring required

Spoonjoy resource id from a previous list response.

coverIdstring required

Recipe cover candidate id from GET /api/v1/recipes/{id}/covers.

Query parameters

clientMutationIdstring

Optional chef-wide idempotency key for DELETE retries when a client cannot send a JSON body.

Headers

X-Client-Mutation-Idstring

Optional chef-wide idempotency key for this delete. Prefer the JSON body clientMutationId when possible, and use the same value when retrying the exact same request after a timeout.

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Request body

clientMutationIdstring required
replacementCoverIdstring nullable
replacementVariant'image' | 'stylized' | 'null' nullable

Active cover variant: image is verbatim/pure AI/imported display; stylized is an editorialized chef photo. Null when no active cover is available.

confirmNoCoverboolean
deleteSafeObjectsboolean

Response

Success

okunknown required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.