Stop a scheduled report's emails, by the token its email carries; an outside address may stop every report from the workspace (everything). A mail client's one-click POST (RFC 8058, a form) is taken too

POST

/v1/shared/unsubscribe/{token}

curl --request POST \
  --url https://example.com/v1/shared/unsubscribe/example \
  --header 'Content-Type: application/json' \
  --data '{ "everything": true }'

Who: anyone.

Parameters

Path Parameters

token

required

string

Request Body^required

Media typeapplication/json

object

everything

boolean

Example ^generated

{
  "everything": true
}

Responses

204

Done; no body

default

An error, as go-commons apperr maps it

Media typeapplication/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}