Skip to main content

Create Account

POST /v1/accounts

Creates a new account for the API key's node.

Headers

HeaderRequiredValue
AuthorizationYesBearer <token>
Content-TypeYesapplication/json
X-Target-ServerYesaccounts

Request Body

FieldTypeRequiredValidationDescription
namestringYesmin: 2, max: 255Account name
typestringYesMust be a valid account typeAccount type
statusintegerYesMust be a valid account statusAccount status
{
"name": "My Organisation Account",
"type": "organisation",
"status": 1
}

Response

201 Created

Account created successfully. No response body.

400 Bad Request

Validation error.

{
"code": 0,
"domain": 0,
"message": "name is required"
}

401 Unauthorized

Invalid or missing token.

500 Internal Server Error