VTEX B2B GraphQL icon

VTEX B2B GraphQL

Interact with VTEX B2B Organizations GraphQL API

Actions15

Organization → Create

AI-generated

Summary

Create a new organization via a GraphQL mutation, optionally using a custom mutation or variables

Inputs

  • customQuery — Custom GraphQL mutation. Leave empty to use default templates.
  • variables — GraphQL variables as JSON object

Output shape

a single organization record returned by the createOrganization mutation, typically including id, name, status, and href

The operation returns the created organization object; errors are caught by continueOnFail and passed through.

Examples

Example 1: Create a new organization using the default mutation

Leave Custom Query empty and provide Variables with the organization input (e.g., {"input":{"name":"Acme"}}).

Example 2: Create using a custom mutation

Enter a custom GraphQL mutation in Custom Query and optionally supply Variables JSON.

Example 3: Create with minimal configuration

Use default mutation and an empty Variables object.

Discussion