Sign in
Organizations

Update Organization

Changed on

Update an organization.

<div> <code>update:organizations</code> </div>
patch/api/v1/organization/{org_code}

Request

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

Path parameters

org_codestring required
Example:org_1ccfb819462

The identifier for the organization.

Query parameters

expand'billing' nullable

Additional data to include in the response. Allowed value: "billing".

Request body

namestring

The organization's name.

external_idstring

The organization's ID.

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_code'light' | 'dark' | 'user_preference'

The organization's brand settings - theme/mode.

handlestring

The organization's handle.

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.

is_auto_join_domain_listboolean

Users can sign up to this organization.

allowed_domainsstring[]

Domains allowed for self-sign up to this environment.

is_enable_advanced_orgsboolean

Activate advanced organization features.

is_enforce_mfaboolean

Enforce MFA for all users in this organization.

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_suspendedboolean

Whether to suspend or unsuspend the organization. Setting to true suspends the organization; setting to false unsuspends it. The default organization cannot be suspended.

Example request

{
  "name": "Acme Corp",
  "external_id": "some1234",
  "background_color": "#fff",
  "button_color": "#fff",
  "button_text_color": "#fff",
  "link_color": "#fff",
  "background_color_dark": "#000",
  "button_color_dark": "#000",
  "button_text_color_dark": "#000",
  "link_color_dark": "#000",
  "theme_code": "light",
  "handle": "acme_corp",
  "is_auto_membership_enabled": true,
  "is_auto_join_domain_list": true,
  "allowed_domains": [
    "https://acme.kinde.com",
    "https://acme.com"
  ],
  "is_enable_advanced_orgs": true,
  "is_enforce_mfa": true,
  "sender_name": "Acme Corp",
  "sender_email": "hello@acmecorp.com"
}

Response

Organization successfully updated.

messagestring
codestring

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes

  • b3e096c729c2Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 0c5023c4d856Revision changes
    • warning

      removed the request property

    • info

      added the new optional query request parameter expand