Update Receipt

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api.onetimesecret.com/doc/v3-api/mcp

Standard setup for AI tools providing an mcp.json file

{
  "v3 - Secrets API (preview) MCP server": {
    "url": "https://api.onetimesecret.com/doc/v3-api/mcp"
  }
}

PATCH /api/v3/receipt/{identifier}

Session auth

Update the memo field on a receipt owned by the authenticated user. Returns the updated receipt record.

Path parameters

identifier string Required

The identifier parameter

application/json

Body Required

object

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- user_id string
- shrimp string
  
  Default value is empty.
- record object Required
  
  Hide record attributes Show record attributes object
  
  identifier string Required
  
  key string Required
  
  shortid string Required
  
  state string Required
  
  Values are new, shared, revealed, burned, previewed, expired, or orphaned.
  
  owner_id string | null
  
  created number Required
  
  updated number Required
  
  shared number | null
  
  previewed number | null
  
  revealed number | null
  
  burned number | null
  
  secret_ttl number Required
  
  receipt_ttl number Required
  
  lifespan number Required
  
  secret_shortid string
  
  secret_identifier string | null
  
  recipients array[string] | null | string
  
  Any of:
  array-1 array[string] | null string-2 string | null
  
  recipient_name string | null
  
  share_domain string | null
  
  has_passphrase boolean | null
  
  is_previewed boolean Required
  
  is_revealed boolean Required
  
  is_burned boolean Required
  
  is_destroyed boolean Required
  
  is_expired boolean Required
  
  is_orphaned boolean Required
  
  memo string | null
  
  kind string | null
  
  Any of:
  string-1 string | null string-2 string | null
  
  Values are generate or conceal.
  
  Value is .
  
  source string | null
  
  Values are standard or incoming.
  
  secret_state string | null
  
  Values are new, shared, revealed, burned, previewed, expired, or orphaned.
  
  natural_expiration string Required
  
  expiration number | null
  
  expiration_in_seconds number Required
  
  share_path string | null
  
  burn_path string Required
  
  receipt_path string Required
  
  share_url string | null
  
  receipt_url string Required
  
  burn_url string Required
- details object
  
  Hide details attributes Show details attributes object
  
  type string Required
  
  Value is record.
  
  display_lines number Required
  
  no_cache boolean Required
  
  secret_realttl number | null
  
  view_count number | null
  
  first_access number | null
  
  last_access number | null
  
  has_passphrase boolean | null
  
  can_decrypt boolean | null
  
  secret_value string | null
  
  show_secret boolean Required
  
  show_secret_link boolean Required
  
  show_receipt_link boolean Required
  
  show_receipt boolean Required
  
  show_recipients boolean Required
  
  is_orphaned boolean | null
  
  is_expired boolean | null
400 application/json

Bad Request - Invalid request parameters or body
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
401 application/json

Unauthorized - Authentication required
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
403 application/json

Forbidden - Insufficient permissions
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
404 application/json

Not Found - Resource does not exist
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
422 application/json

Unprocessable Entity - Validation failed
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
500 application/json

Internal Server Error - Something went wrong
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.

PATCH /api/v3/receipt/{identifier}

curl \
 --request PATCH 'https://uk.onetimesecret.com/api/v3/receipt/{identifier}' \
 --cookie "rack.session=$API_KEY" \
 --header "Content-Type: application/json"

Request examples

{}

Response examples (200)

{
  "user_id": "string",
  "shrimp": "",
  "record": {
    "identifier": "string",
    "key": "string",
    "shortid": "string",
    "state": "new",
    "owner_id": "string",
    "created": 42.0,
    "updated": 42.0,
    "shared": 42.0,
    "previewed": 42.0,
    "revealed": 42.0,
    "burned": 42.0,
    "secret_ttl": 42.0,
    "receipt_ttl": 42.0,
    "lifespan": 42.0,
    "secret_shortid": "string",
    "secret_identifier": "string",
    "recipients": [
      "string"
    ],
    "recipient_name": "string",
    "share_domain": "string",
    "has_passphrase": true,
    "is_previewed": true,
    "is_revealed": true,
    "is_burned": true,
    "is_destroyed": true,
    "is_expired": true,
    "is_orphaned": true,
    "memo": "string",
    "kind": "generate",
    "source": "standard",
    "secret_state": "new",
    "natural_expiration": "string",
    "expiration": 42.0,
    "expiration_in_seconds": 42.0,
    "share_path": "string",
    "burn_path": "string",
    "receipt_path": "string",
    "share_url": "string",
    "receipt_url": "string",
    "burn_url": "string"
  },
  "details": {
    "type": "record",
    "display_lines": 42.0,
    "no_cache": true,
    "secret_realttl": 42.0,
    "view_count": 42.0,
    "first_access": 42.0,
    "last_access": 42.0,
    "has_passphrase": true,
    "can_decrypt": true,
    "secret_value": "string",
    "show_secret": true,
    "show_secret_link": true,
    "show_receipt_link": true,
    "show_receipt": true,
    "show_recipients": true,
    "is_orphaned": true,
    "is_expired": true
  }
}

Response examples (400)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (401)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (403)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (404)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (422)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (500)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Update Receipt

Path parameters

Body Required

Responses

recipients array[string] | null | string

kind string | null