Update Account - SnackBase

PUT

api

accounts

{account_id}

Update Account

curl --request PUT \
  --url https://api.example.com/api/v1/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

{
  "id": "<string>",
  "account_code": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_count": 123,
  "collections_used": [
    "<string>"
  ]
}

Path Parameters

account_id

string

required

Body

application/json

Request body for updating an account.

name

string

required

Account name

Required string length: 1 - 255

Response

Successful Response

Detailed account information.

string

required

Account ID (UUID)

account_code

string

required

Human-readable account code in XX#### format (e.g., AB1234)

slug

string

required

URL-friendly account identifier

name

string

required

Display name for the account

created_at

string<date-time>

required

When the account was created

updated_at

string<date-time>

required

When the account was last updated

user_count

integer

required

Number of users in this account

collections_used

string[]

Collections used by this account

Delete AccountDelete an account. Deletes the account and all associated users and data (cascade). System account (nil UUID) cannot be deleted. Only superadmins can access this endpoint.

Update Account

curl --request PUT \
  --url https://api.example.com/api/v1/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

{
  "id": "<string>",
  "account_code": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_count": 123,
  "collections_used": [
    "<string>"
  ]
}