Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • custid string Required
  • metadata_key string Required
  • secret_key string
  • state string Required

    Values are new, received, viewed, burned, expired, or orphaned.

  • created integer | null Required

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • updated integer | null Required

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • received integer

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • ttl integer | null Required

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • metadata_ttl integer | null Required

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • secret_ttl integer | null

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • metadata_url string | null
  • share_domain string Required
  • recipient array[string] Required
  • passphrase_required boolean
  • value string
  • identifier string Required

    v0.24 name for metadata_key. Prefer this field for new integrations.

  • secret_identifier string
  • has_passphrase boolean
  • recipients array[string] Required

    v0.24 name for recipient.

  • receipt_ttl integer | null Required

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

  • receipt_url string | null
  • secret_value string
• 401 application/json

  Unauthorized - Authentication required

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 403 application/json

  Forbidden - Insufficient permissions

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 404 application/json

  Not Found - Resource does not exist

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 500 application/json

  Internal Server Error - Something went wrong

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier