Create Sandbox

Beta

POST/v1/core/sandboxes

Idempotent with Idempotency-Key header. Learn more

Creates a sandbox account owned by your production account.

When mode is seeded, sample data is populated asynchronously and may not be available immediately after the sandbox is created. Sandboxes cannot be created while acting in a sandbox.

Permissions requiredValues:sandboxes:create

The role behind your API key or agent must grant every one of these permissions.

include[]optional arrayenumValues:owner_account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name of the sandbox.

modeoptional stringenumValues:blankseeded

Controls how the sandbox is initialized. Defaults to blank.

blank: starts empty, with no pre-populated data.
seeded: starts with sample data, populated asynchronously after the sandbox is created.

idstring

Sandbox ID.

objectstringenumValues:sandbox

Resource type identifier.

namestring

Display name of the sandbox.

owner_accountaccountExpandablenullable

The production account that owns this sandbox.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this sandbox was created.

updated_atstring (date-time)

When this sandbox was last updated.

Responses

201

Successful response for Create Sandbox

Create Sandbox

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.create({ name: 'Integration Testing', mode: 'blank' });

console.log(sandbox.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.create({ name: 'Integration Testing', mode: 'blank' });

console.log(sandbox.id);

201 example

{
  "id": "sbac_01ebd87c707b138806f060b9ae",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_01148680966698341a9c0976db",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "sbac_01ebd87c707b138806f060b9ae",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_01148680966698341a9c0976db",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Sandbox

Authorization

Query Parameters

Request Body

Returns

Responses