Organizations

Create organization

Changed on

Create a new organization. To learn more read about multi tenancy using organizations

<div> <code>create:organizations</code> </div>
post/api/v1/organization

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/organization
  • Auth: HTTP bearer

Request body

namestring required

The organization's name.

feature_flagsobject

The organization's feature flag settings.

external_idstring

The organization's external identifier - commonly used when migrating from or mapping to other systems.

background_colorstring

The organization's brand settings - background color.

button_colorstring

The organization's brand settings - button color.

button_text_colorstring

The organization's brand settings - button text color.

link_colorstring

The organization's brand settings - link color.

background_color_darkstring

The organization's brand settings - dark mode background color.

button_color_darkstring

The organization's brand settings - dark mode button color.

button_text_color_darkstring

The organization's brand settings - dark mode button text color.

link_color_darkstring

The organization's brand settings - dark mode link color.

theme_codestring

The organization's brand settings - theme/mode 'light' | 'dark' | 'user_preference'.

handlestring

A unique handle for the organization - can be used for dynamic callback urls.

is_allow_registrationsboolean

Deprecated - Use 'is_auto_membership_enabled' instead.

is_auto_membership_enabledboolean

If users become members of this organization when the org code is supplied during authentication.

sender_namestring nullable

The name of the organization that will be used in emails

sender_emailstring nullable

The email address that will be used in emails. Requires custom SMTP to be set up.

is_create_billing_customerboolean

If an organization billing customer is also created for this organization

billing_emailstring

The email address used for billing purposes for the organization. Required when is_create_billing_customer is true

billing_plan_codestring

Code of a published organization billing plan to assign to the new billing customer. If omitted, the default organization plan is used. User plans and unpublished plans are rejected.

Example request

{
  "name": "Acme Corp",
  "external_id": "some1234",
  "handle": "acme_corp",
  "is_allow_registrations": true,
  "is_auto_membership_enabled": true,
  "sender_name": "Acme Corp",
  "sender_email": "hello@acmecorp.com",
  "billing_email": "billing@acmecorp.com",
  "billing_plan_code": "pro"
}

Response

Organization successfully created.

messagestring

Response message.

codestring

Response code.

Example response

{
  "message": "Success",
  "code": "OK",
  "organization": {
    "code": "org_1ccfb819462",
    "billing_customer_id": "customer_1245adbc6789"
  }
}

Changes

  • b3e096c729c2Revision changes
    • info

      added the new optional request property

    • info

      request property deprecated

  • 0c5023c4d856Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status