TukiGrowth icon

TukiGrowth

Interact with the TukiGrowth API

Actions185

Client → Create

AI-generated

Summary

Create a new client within a specified organization by providing mandatory details such as name, slug, business type, and entity type, along with optional additional fields.

Inputs

  • organizationId (required) — Select the organization under which to create the client; supports choosing from a list or providing an ID.
  • name (required) — Name of the client to create.
  • slug (required) — URL-friendly identifier for the client.
  • businessType (required) — Type of business for the client; options include Ecommerce, Services, Mixed, or Other.
  • entityType (required) — Entity type of the client; defaulted options are Business or Individual, but custom values can also be entered.
  • additionalFields — Optional fields including Website URL, Timezone (default 'UTC'), Primary Language (default 'es'), Status (Active, Paused, Archived), and Channels as a JSON array string.
  • options — Settings for output format such as Simplify Output (defaults to true) and Debug Mode (defaults to false).

Output shape

a single record representing the newly created client

The output can be simplified or detailed based on the 'simplifyOutput' option; debug information can be included if 'debugMode' is enabled.

Examples

Example 1: Create a client 'Acme Corp' with business type 'Ecommerce' under organization selected from list, with default timezone and primary language.

organizationId from list, name='Acme Corp', slug='acme-corp', businessType='ecommerce', entityType='business', additionalFields left default, simplifyOutput=true

Example 2: Create an individual client specifying custom entityType and including website and status, using direct organization ID.

organizationId by ID, name='John Doe', slug='john-doe', businessType='services', entityType='individual', additionalFields with websiteUrl and status='paused', simplifyOutput=false, debugMode=true

Links

Discussion