You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
1.8 KiB
YAML
60 lines
1.8 KiB
YAML
get:
|
|
tags:
|
|
- emails
|
|
summary: Unsubscribe user from email type (user variant)
|
|
parameters:
|
|
- name: token
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: testToken
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
payload:
|
|
type: object
|
|
properties:
|
|
uid:
|
|
type: number
|
|
template:
|
|
type: string
|
|
description: The type of email template to unsubscribe from.
|
|
enum:
|
|
- digest
|
|
- notification
|
|
type:
|
|
type: string
|
|
description: Only used if `template` is `notification`, signifies the type of notification to unsubscribe from.
|
|
nullable: true
|
|
iat:
|
|
type: number
|
|
description: Reflection of the token's "issued at" claim
|
|
required:
|
|
- uid
|
|
- template
|
|
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
|
"500":
|
|
description: "Server-side error (likely token verification failure)"
|
|
post:
|
|
tags:
|
|
- emails
|
|
summary: Unsubscribe user from email type (auto variant)
|
|
parameters:
|
|
- name: token
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: testToken
|
|
responses:
|
|
"200":
|
|
description: "Successfully unsubscribed"
|
|
"500":
|
|
description: "Server-side error (likely token verification failure)" |