Mark a notification read

POST

/notifications/{id}/read

const url = 'https://example.com/notifications/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/read';
const options = {
  method: 'POST',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/notifications/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/read \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

sessionCookie
tenant:read
apiKey
tenant:read

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

204

Read

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

A key, not a person: notices belong to people

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not one of theirs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}