/v0/accounts/:name

PATCH

/v0/accounts/:name

const url = 'http://localhost:3000/v0/accounts/:name';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"nickname":"Johndoe<:typescript:3939849792873>","email":"john@example.com","passphrase":"じゃすた・いぐざんぽぅ","bio":""}'
};

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

curl --request PATCH \
  --url http://localhost:3000/v0/accounts/:name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "nickname": "Johndoe<:typescript:3939849792873>", "email": "john@example.com", "passphrase": "じゃすた・いぐざんぽぅ", "bio": "" }'

Authorizations

bearer

Parameters

Path Parameters

name

required

Characters must be [A-Za-z0-9-.] The first and last characters must be [A-Za-z0-9-.]

string

>= 3 characters <= 64 characters

Example

example_man

Characters must be [A-Za-z0-9-.] The first and last characters must be [A-Za-z0-9-.]

Request Body

application/json

object

nickname

Nickname

string

>= 1 characters <= 256 characters

email

Email address

string format: email

Example

john@example.com

passphrase

Passphrase

string

>= 8 characters <= 512 characters

Example

じゃすた・いぐざんぽぅ

bio

required

Biography

string

0 <= 1024 characters

Responses

200

application/json

object

required

Account ID

string

name

required

Account name

string

nickname

required

Account nickname

string

bio

required

Biography

string

0 <= 1024 characters

email

required

Account email address

string format: email

Example

{
  "id": "38477395",
  "name": "@example_man@example.com",
  "nickname": "John Doe",
  "bio": "",
  "email": "foo@example.com"
}

202

When email updated

application/json

object

required

Account ID

string

name

required

Account name

string

nickname

required

Account nickname

string

bio

required

Biography

string

0 <= 1024 characters

email

required

Account email address

string format: email

Example

{
  "id": "38477395",
  "name": "@example_man@example.com",
  "nickname": "John Doe",
  "bio": "",
  "email": "foo@example.com"
}

400

Bad Request

application/json

object

error

required

Any of:

string
string

Contains unusable character types in parameters.

string

Allowed values: INVALID_SEQUENCE

Example

{
  "error": "INVALID_SEQUENCE"
}

404

Not Found

application/json

Account not found

object

error

required

Account not found.

string

Allowed values: ACCOUNT_NOT_FOUND

Example

{
  "error": "ACCOUNT_NOT_FOUND"
}

500

Internal Server Error

application/json

object

error

required

Internal server error.

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}