Update a Directory

Updates an existing directory. Only provided fields will be modified; omitted fields remain unchanged.

Available for Internal tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the directory

Body Params
string

Name of the directory. Used only internally.

string

Partner-facing display name for the directory.

integer | null

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

string

Administrative contact email for the directory.

string
enum

Billing type for the directory.

Allowed:
string | null
enum

Manual type of the directory.

Allowed:
string

Configuration key for the directory.

string | null

ID of the branding theme applied to the directory.

string | null

ID of the management theme applied to the directory.

management_theme_attributes
object

Attributes for the management theme associated with the directory.

boolean

Indicates if the directory is managed by a partner.

boolean

Indicates if the directory is deprecated.

boolean

Indicates if slim registration mode is enabled during onboarding.

string

Default locale for the directory.

string

Default time zone for the directory.

string

PayPal email for the directory.

number

Revenue share percentage.

number | null

Revenue share percentage for tier 2.

boolean

When true, only the business owner is redirected to the logout URL on logout.

string

Custom SMS sending phone number.

settings
object

Directory settings and configuration options. Only provided sub-fields will be updated.

welcome_engagement_params
object | null

Welcome engagement parameters.

boolean

Indicates if unsubscribe text is added to SMS messages.

boolean

Indicates if analytics are disabled.

boolean

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

boolean

Indicates if the directory manages user identities.

integer

Default package ID assigned to new businesses in this directory.

boolean

Indicates if default self paid is enabled.

string

Mobile app name.

string

iOS mobile app URL.

string

Android mobile app URL.

string

Email template owner UID.

urls
object

Collection of setup URLs. Only provided sub-fields will be updated.

domain_hosting
object

Domain and hosting configuration. Only provided sub-fields will be updated.

configs
array of strings

Directory-level configuration flags.

Responses

401

Unauthorized

403

Forbidden

404

Directory not found

500

Internal server error

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json