Skip to content
go-api-boilerplate

Change the address to the one the code was mailed to.

POST
/v1/me/email-change/confirm
curl --request POST \
  --url https://example.com/api/user/v1/me/email-change/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
code
required

The code from the mailed link.

string

Example generated

{
  "code": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The user, with the new address.

Media typeapplication/json
object
id
required
string format: uuid
email
required
string format: email
google_linked
required
boolean
created_at
required
string format: date-time

Example generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "hello@example.com",
  "google_linked": true,
  "created_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

A malformed body, or a code that is unknown, used, expired or another user’s.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

No access token, or one that is invalid or expired.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}

Headers

Section titled “Headers”
WWW-Authenticate
required
string
Allowed value: Bearer

403

Section titled “403”

The token isn’t a user’s, lacks the scope, or the request came from another origin.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}

409

Section titled “409”

Another account has the address now. The code stays usable.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}

413

Section titled “413”

The body is larger than 4 KiB.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}

500

Section titled “500”

Something failed on the server; the request ID leads to the log line.

Media typeapplication/problem+json

An RFC 9457 problem.

object
type
required
string
title
required
string
status
required
integer
detail

Written for the user.

string
instance
string
request_id
string
errors

What is wrong with each field of the request.

object
key
additional properties
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": "example"
  }
}