Create an account

POST 
/v2/accounts

With the account creation endpoint, you have the ability to create parent accounts and subaccounts.

Request

application/json

Body

data object required

oneOf

Account

type string

Default value: account

Specifies the the type of object. Set this value to account.

name string

Specifies the name of the account.

legal_name string

Specifies the legal name of the account.

registration_id string

Specifies the registration ID. If specified, this field is checked for uniqueness.

external_ref string

The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

SubAccount

type string

Default value: account

Specifies the the type of object. Set this value to account.

name string

Specifies the name of the account.

legal_name string

Specifies the legal name of the account.

registration_id string

Specifies the registration ID. If specified, this field is checked for uniqueness.

external_ref string

The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

parent_id string

Specifies the ID of the parent account.

Responses

201

Created

application/json

Schema

Schema

data object

type string

Default value: account

Specifies the the type of object. Set this value to account.

name string

Specifies the name of the account.

legal_name string

Specifies the legal name of the account.

registration_id string

Specifies the registration ID. If specified, this field is checked for uniqueness.

external_ref string

The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

id UUID (string)

The unique identifier for an Account.

meta object

Additional information for this realm. For more information, see The meta object section.

timestamps object

created_at string

The date the account is created.

updated_at string

The date the account is updated.

links object

self string

A URL to the specific resource.

Example (from schema)

{
  "data": {
    "type": "account",
    "name": "acc-name",
    "legal_name": "acc-legal-name",
    "registration_id": "reg-id",
    "external_ref": "ext-ref",
    "id": "deb6b25f-8451-4211-9a22-95610333df23",
    "meta": {
      "timestamps": {
        "created_at": "2021-02-23T09:40:33.882Z",
        "updated_at": "2021-02-23T09:40:33.882Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
status string
The HTTP response code of the error.
title string
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

bad-request-error

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "detail": "Validation failed: field 'Name' on the 'min' tag."
    }
  ]
}

Loading...