Create a Directory

post

https://api.vcita.biz/v3/business_administration/directories

Creates a new directory with the provided configuration.

Available for Internal tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Name of the directory. Used only internally.

partner_name

string

Partner-facing display name for the directory (e.g., "samplepartner").

parent_directory_id

integer | null

ID of the parent directory, if this directory is a child of another directory.

admin_email

string

Administrative contact email for the directory (e.g., "[email protected]").

billing_type

string

enum

required

Billing type for the directory.

Allowed:

manual_type

string | null

enum

Manual type of the directory. Use this to ensure Solution Provider / White Label features even if the directory owner didn't pay for it or there was a payment issue.

Allowed:

configuration_key

string

required

Configuration key for the directory.

branding_theme_id

string | null

ID of the branding theme applied to the directory.

management_theme_id

string | null

ID of the management theme applied to the directory.

management_theme_attributes

object

Attributes for the management theme associated with the directory.

is_managed

boolean

Indicates if the directory is managed by a partner. Relevant for reports only.

is_deprecated

boolean

Indicates if the directory is deprecated.

is_slim_register_enabled

boolean

Indicates if slim registration mode is enabled during onboarding.

locale

string

Default locale for the directory.

time_zone

string

Default time zone for the directory.

paypal_email

string

PayPal email for the directory.

rev_share

number

Revenue share percentage (e.g., 20).

rev_share_tier2

number | null

Revenue share percentage for tier 2.

only_owner_login_redirect

boolean

When true, only the business owner is redirected to the logout URL on logout. When false and logout URL is defined, all logged-out users are redirected.

custom_sms_sending_phone_number

string

Custom SMS sending phone number.

settings

object

Directory settings and configuration options.

welcome_engagement_params

object | null

Welcome engagement parameters.

is_unsubscribe_sms

boolean

Indicates if unsubscribe text is added to SMS messages.

is_disable_analytics

boolean

Indicates if analytics are disabled.

is_content_manager_enabled

boolean

Indicates if the directory is added to Verticalization (content manager).

is_user_identity_manager_enabled

boolean

Indicates if the directory manages user identities.

default_package_id

integer

Default package ID assigned to new businesses in this directory.

is_default_self_paid

boolean

Indicates if default self paid is enabled.

mobile_app_name

string

Mobile app name.

mobile_app_ios

string

iOS mobile app URL.

mobile_app_android

string

Android mobile app URL.

email_template_owner_uid

string

Email template owner UID.

urls

object

Collection of setup URLs related to the directory.

domain_hosting

object

Domain and hosting configuration for the directory's whitelabel setup.

configs

array of strings

Directory-level configuration flags that control behavior and categorization.

Responses

401

Unauthorized

403

Forbidden

500

Internal server error

201Directory created successfully.

400Bad Request - Malformed request or invalid syntax.

422Unprocessable Entity - Validation error.