PATCH
/
api
/
v1
/
me
Update My Venture
curl --request PATCH \
  --url http://localhost:8080/api/v1/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "rotate_api_key": true
}
'
{
  "api_key_prefix": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "api_key": "<string>"
}

Body

application/json

Partial update for a venture. Omitted fields are left unchanged.

​
name
string | null
​
rotate_api_key
boolean

Rotate the API key. The previous key stops working immediately and the new plaintext key is returned ONCE.

​
status
null | enum<string>

New status (ACTIVE / DISABLED). Admin-only in practice.

Available options:
ACTIVE,
DISABLED

Response

Updated; rotated API key returned ONCE

Response to a venture update. api_key is present only when rotated (ONCE).

​
api_key_prefix
string
required
​
id
string<uuid>
required
​
name
string
required
​
status
enum<string>
required

Whether a venture may authenticate and transact.

Available options:
ACTIVE,
DISABLED
​
updated_at
string<date-time>
required
​
api_key
string | null