Mark submissions as read

POST

/v1/forms/{form}/submissions/mark-read

curl --request POST \
  --url https://api.submeto.com/v1/forms/example/submissions/mark-read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ids": [ "REQUEST_ID", "REQUEST_ID" ] }'

Marks an explicit, complete set of submissions as read (1-100 IDs). IDs that do not resolve cause a 404 without partial marking. Requires the submissions:mark_read scope.

Authorizations

• default

Parameters

Path Parameters

form

required

string

The form ID.

Request Body^required

Media typeapplication/json

object

ids

required

The submission IDs to mark as read (1-100 unique ULIDs).

Array<string>

Example

[
  "REQUEST_ID",
  "REQUEST_ID"
]

Responses

200

Marked as read

Media typeapplication/json

object

data

object

requested_count

integer

marked_read_count

integer

already_read_count

integer

request_id

string

Example

{
  "data": {
    "requested_count": 2,
    "marked_read_count": 2,
    "already_read_count": 0
  },
  "request_id": "REQUEST_ID"
}

404

Not found or not granted

Media typeapplication/json

object

error

object

code

string

message

string

details

object

request_id

string

Example

{
  "error": {
    "code": "resource_not_found",
    "message": "Resource not found.",
    "details": {}
  },
  "request_id": "REQUEST_ID"
}