Confirms an email address with the delivered token.
Open to anyone: holding the token is what proves control of the address, whoever is or is not signed in.
Authorizations
Section titled “Authorizations”- None
Request Bodyrequired
Section titled “Request Bodyrequired”Email verification confirmation.
object
Token delivered to the email address.
Examplegenerated
{ "token": "example"}Responses
Section titled “Responses”Email verified
Invalid or expired token
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is too large
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is not JSON
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The media type the operation takes.
Too many requests
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”Seconds to wait. Sent when the limit knows when it lifts.
The service failed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The service is at capacity
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}