Update account

PUT

accounts

curl --request PUT \
  --url https://api.mudstack.com/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-account-id: <x-account-id>' \
  --form 'body={}'

{
  "id": "<string>",
  "name": "<string>",
  "account_tier_id": "<string>",
  "thumbnail_file_id": "<string>",
  "created_by_user_id": "<string>",
  "defaultAvatar": 123,
  "sequence": 123,
  "subscription": {
    "account_id": "<string>",
    "stripe_customer_id": "<string>",
    "status": "<string>",
    "licenses": 123,
    "frequency": "yearly",
    "contact": "<string>"
  },
  "members": {
    "account_id": "<string>",
    "user_id": "<string>",
    "roles": [
      "<string>"
    ],
    "user": {
      "id": "<string>",
      "auth0UserID": "<string>",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatar_file_id": "<string>",
      "defaultAvatar": 123,
      "industry": "<string>",
      "occupation": "<string>",
      "company": "<string>",
      "emailVerified": true,
      "isActive": true,
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zipCode": "<string>",
      "invited_by_user": {}
    }
  },
  "tier": {
    "id": "<string>",
    "type": "personal",
    "name": "<string>",
    "maxStorage": 123,
    "costPerLicense": 123,
    "costPerExtraTB": 123
  },
  "type": {
    "id": "<string>",
    "name": "<string>",
    "maxStorage": 123,
    "maxAssets": 123,
    "maxUsers": 123,
    "costPerUser": 123,
    "addStoragePrice": 123
  },
  "creator": {
    "id": "<string>",
    "auth0UserID": "<string>",
    "username": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatar_file_id": "<string>",
    "defaultAvatar": 123,
    "industry": "<string>",
    "occupation": "<string>",
    "company": "<string>",
    "emailVerified": true,
    "isActive": true,
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>",
    "invited_by_user": {}
  },
  "workspaces": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "defaultAvatar": 1,
      "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence": "<string>",
      "roles": {
        "workspace_id": "<string>",
        "user_id": "<string>",
        "roles": [
          "<string>"
        ],
        "user": {
          "id": "<string>",
          "auth0UserID": "<string>",
          "username": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "avatar_file_id": "<string>",
          "defaultAvatar": 123,
          "industry": "<string>",
          "occupation": "<string>",
          "company": "<string>",
          "emailVerified": true,
          "isActive": true,
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zipCode": "<string>",
          "invited_by_user": {}
        }
      },
      "usage": {}
    }
  ],
  "isCreator": true,
  "account_roles": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-account-id

string

required

Body

multipart/form-data

file

body

object

Response

200 - application/json

Account updated successfully

Represents an account with various properties and relationships.

string

Unique identifier for the account.

name

string

Name of the account.

account_tier_id

string

Identifier for the account tier.

thumbnail_file_id

string

Optional identifier for the thumbnail file.

created_by_user_id

string

Optional identifier for the user who created the account.

defaultAvatar

number

Default avatar for the account.

sequence

integer

Sequence number for the account.

subscription

object

Optional subscription details for the account.

members

object

Optional members associated with the account.

members.account_id

string

The unique identifier of the account.

members.user_id

string

The unique identifier of the user.

members.roles

string[]

The roles assigned to the user within the account.

members.user

object

The user associated with the account member.

members.user.id

string

Unique identifier for the user

members.user.auth0UserID

string

Auth0 user ID

members.user.username

string

Username of the user

members.user.email

string

Email address of the user

members.user.firstName

string

First name of the user

members.user.lastName

string

Last name of the user

members.user.avatar_file_id

string

File ID of the user's avatar

members.user.defaultAvatar

number

Default avatar identifier

members.user.industry

string

Industry the user works in

members.user.occupation

string

Occupation of the user

members.user.company

string

Company the user works for

members.user.emailVerified

boolean

Whether the user's email is verified

members.user.isActive

boolean

Whether the user is active

members.user.city

string

City where the user resides

members.user.state

string

State where the user resides

members.user.country

string

Country where the user resides

members.user.zipCode

string

Zip code of the user's location

members.user.invited_by_user

object

User who invited this user

tier

object

Optional tier details for the account.

type

object

Optional type details for the account.

creator

object

Optional creator details for the account.

creator.id

string

Unique identifier for the user

creator.auth0UserID

string

Auth0 user ID

creator.username

string

Username of the user

creator.email

string

Email address of the user

creator.firstName

string

First name of the user

creator.lastName

string

Last name of the user

creator.avatar_file_id

string

File ID of the user's avatar

creator.defaultAvatar

number

Default avatar identifier

creator.industry

string

Industry the user works in

creator.occupation

string

Occupation of the user

creator.company

string

Company the user works for

creator.emailVerified

boolean

Whether the user's email is verified

creator.isActive

boolean

Whether the user is active

creator.city

string

City where the user resides

creator.state

string

State where the user resides

creator.country

string

Country where the user resides

creator.zipCode

string

Zip code of the user's location

creator.invited_by_user

object

User who invited this user

workspaces

object[]

List of workspaces associated with the account.

workspaces.id

string

Unique identifier for the workspace.

workspaces.account_id

string

Unique identifier for the account associated with the workspace.

workspaces.name

string

Name of the workspace.

workspaces.thumbnail_file_id

string

Unique identifier for the thumbnail file associated with the workspace.

workspaces.defaultAvatar

integer

default:1

Default avatar for the workspace.

Required range: 1 <= x <= 10

workspaces.created_by_user_id

string

Unique identifier for the user who created the workspace.

workspaces.sequence

string

Sequence number for the workspace.

workspaces.roles

object

Roles associated with the workspace.

workspaces.roles.workspace_id

string

required

The ID of the workspace.

workspaces.roles.user_id

string

required

The ID of the user.

workspaces.roles.roles

string[]

required

The roles assigned to the user in the workspace.

workspaces.roles.user

object

The user details.

workspaces.roles.user.id

string

Unique identifier for the user

workspaces.roles.user.auth0UserID

string

Auth0 user ID

workspaces.roles.user.username

string

Username of the user

workspaces.roles.user.email

string

Email address of the user

workspaces.roles.user.firstName

string

First name of the user

workspaces.roles.user.lastName

string

Last name of the user

workspaces.roles.user.avatar_file_id

string

File ID of the user's avatar

workspaces.roles.user.defaultAvatar

number

Default avatar identifier

workspaces.roles.user.industry

string

Industry the user works in

workspaces.roles.user.occupation

string

Occupation of the user

workspaces.roles.user.company

string

Company the user works for

workspaces.roles.user.emailVerified

boolean

Whether the user's email is verified

workspaces.roles.user.isActive

boolean

Whether the user is active

workspaces.roles.user.city

string

City where the user resides

workspaces.roles.user.state

string

State where the user resides

workspaces.roles.user.country

string

Country where the user resides

workspaces.roles.user.zipCode

string

Zip code of the user's location

workspaces.roles.user.invited_by_user

object

User who invited this user

workspaces.usage

object

Usage information for the workspace.

isCreator

boolean

Optional flag indicating if the user is the creator of the account.

account_roles

string[]

Optional list of roles associated with the account.

Was this page helpful?

Get account metadata Delete account

curl --request PUT \
  --url https://api.mudstack.com/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-account-id: <x-account-id>' \
  --form 'body={}'

{
  "id": "<string>",
  "name": "<string>",
  "account_tier_id": "<string>",
  "thumbnail_file_id": "<string>",
  "created_by_user_id": "<string>",
  "defaultAvatar": 123,
  "sequence": 123,
  "subscription": {
    "account_id": "<string>",
    "stripe_customer_id": "<string>",
    "status": "<string>",
    "licenses": 123,
    "frequency": "yearly",
    "contact": "<string>"
  },
  "members": {
    "account_id": "<string>",
    "user_id": "<string>",
    "roles": [
      "<string>"
    ],
    "user": {
      "id": "<string>",
      "auth0UserID": "<string>",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatar_file_id": "<string>",
      "defaultAvatar": 123,
      "industry": "<string>",
      "occupation": "<string>",
      "company": "<string>",
      "emailVerified": true,
      "isActive": true,
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zipCode": "<string>",
      "invited_by_user": {}
    }
  },
  "tier": {
    "id": "<string>",
    "type": "personal",
    "name": "<string>",
    "maxStorage": 123,
    "costPerLicense": 123,
    "costPerExtraTB": 123
  },
  "type": {
    "id": "<string>",
    "name": "<string>",
    "maxStorage": 123,
    "maxAssets": 123,
    "maxUsers": 123,
    "costPerUser": 123,
    "addStoragePrice": 123
  },
  "creator": {
    "id": "<string>",
    "auth0UserID": "<string>",
    "username": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatar_file_id": "<string>",
    "defaultAvatar": 123,
    "industry": "<string>",
    "occupation": "<string>",
    "company": "<string>",
    "emailVerified": true,
    "isActive": true,
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>",
    "invited_by_user": {}
  },
  "workspaces": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "defaultAvatar": 1,
      "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence": "<string>",
      "roles": {
        "workspace_id": "<string>",
        "user_id": "<string>",
        "roles": [
          "<string>"
        ],
        "user": {
          "id": "<string>",
          "auth0UserID": "<string>",
          "username": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "avatar_file_id": "<string>",
          "defaultAvatar": 123,
          "industry": "<string>",
          "occupation": "<string>",
          "company": "<string>",
          "emailVerified": true,
          "isActive": true,
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zipCode": "<string>",
          "invited_by_user": {}
        }
      },
      "usage": {}
    }
  ],
  "isCreator": true,
  "account_roles": [
    "<string>"
  ]
}

Core Concepts

Examples

Endpoints

Authorizations

Headers

Body

Response