Owner

Update the owner's profile

Updates the owner's username, email or name, or removes the avatar, and returns the profile fields you can read. Requires profile write permission for every submitted field. All fields commit together. Changing the username needs no confirmation.

PATCH
/profile

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
username?string

The username the owner signs in with: 1 to 64 letters a to z, numbers, dots, dashes and underscores. Marfa stores it in lowercase, with spaces at each end trimmed. Signing in with the old username stops at once.

Length1 <= length <= 64
email?|

The owner's email address, which plays no part in signing in. Marfa stores it in lowercase, with spaces at each end trimmed. Set it to null to remove it.

Formatemail
Lengthlength <= 254
name?string

Display name, without control or bidirectional formatting characters. Spaces at each end are trimmed.

Length1 <= length <= 200
avatar?null

Set avatar to null to remove the owner's avatar, or omit it to leave it unchanged. To set an avatar, send its bytes to PUT /profile/avatar.

Response body

About errors

Returns the profile fields you can read. The profile was updated.

application/json
  1. response

The owner's profile, as far as your credential can read it.

name?string

The owner's name. Present with profile.name:read.

username?string

The owner's username, which password sign-in matches. Present with profile.username:read.

email?|

The owner's email address, or null when none is set. Present with profile.email:read.

Formatemail
avatar?|

The address of the owner's avatar, or null when there is none. Present with profile.avatar:read. Fetch it with GET /profile/avatar.

Formaturi

The body is empty, contains an unknown field, or a field is invalid.

application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

The credential lacks profile write permission for a submitted field.

application/json
  1. response

An error response.

error*

What went wrong.

The owner is unavailable.

application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X PATCH 'http://localhost:8600/profile' \  -H 'Content-Type: application/json' \  -d '{}'
About errors
{  "name": "Alex Example",  "username": "alex",  "email": "alex@example.com",  "avatar": null}