Account

Creates an account with an admin user.

Use this call to create a new account.<br>You must have this scope: 'account.create'.<br>For fine-grained clients, you must have this permission: 'core.accounts.create'.

post/account/v0-nsfw/accounts

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/account/v0-nsfw/accounts
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: account.create

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring nullable

The code for the account that can be shown in reports and table views. If not set, random one will be generated

namestring required

The name for the account, which usually should be the company name

descriptionstring nullable

The description for the account

defaultLanguagestring required

The default language code for the account

logoUrlstring nullable

The URL of the account logo

type'Trial' | 'Live' | 'Suspended' | 'Development' required

Set the type of the account

Example request

{
  "code": "DEMO",
  "name": "Demo Account",
  "description": "This is the demo account",
  "defaultLanguage": "en",
  "logoUrl": "logo.png",
  "type": "Trial",
  "location": {
    "addressLine1": "My Street 1",
    "postalCode": "12345",
    "city": "MyCity",
    "countryCode": "GB"
  }
}

Response

Creation of the new account was successful.

codestring required

Account code

Example response

{
  "code": "DEMO"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.