Return a submission to the inbox

PUT

/api/v1/form-submissions/{id}/ham

curl --request PUT \
  --url https://api.deploybase.eu/api/v1/api/v1/form-submissions/example/ham \
  --header 'Authorization: <Authorization>'

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Submission ID

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

counted

Counted tracks whether this counted against the team’s monthly quota. Ham only.

boolean

country_code

string

created_at

string

data

Data is the submitted payload minus the reserved _-prefixed control fields.

NOTE: this is a Go map, so field order is not preserved — the order the visitor’s form declared its fields is lost at insert. Anything rendering these must impose its own order: CSV export sorts the key union, and encoding/json sorts on marshal.

object

form_id

string

id

string

ip_truncated

string

notified_at

NotifiedAt records when the notification worker finished handling this row (email sent, digested, or deliberately skipped). NULL = pending.

string

purge_after

string

reply_to

string

spam_reasons

Array<string>

spam_score

number

status

string

Allowed values: inbox spam trash

subject

Subject is the sanitized _subject control field (CR/LF stripped at ingest), used only as an email subject override by the notification worker. NULL when the visitor sent none.

string

team_id

string

Example

{
  "data": {
    "status": "inbox"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}