Business

Update business

Changed on

Update your business details.

<div> <code>update:businesses</code> </div>
patch/api/v1/business

Request

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

Request body

business_namestring nullable

The name of the business.

emailstring nullable

The email address of the business.

industry_keystring nullable

The key of the industry of your business. Can be retrieved from the /industries endpoint.

is_click_wrapboolean nullable

Whether the business is using clickwrap agreements.

is_show_kinde_brandingboolean nullable

Whether the business is showing Kinde branding. Requires a paid plan.

kinde_perk_codestring nullable

The Kinde perk code for the business.

phonestring nullable

The phone number of the business.

privacy_urlstring nullable

The URL to the business's privacy policy.

terms_urlstring nullable

The URL to the business's terms of service.

timezone_keystring nullable

The key of the timezone of your business. Can be retrieved from the /timezones endpoint.

Example request

{
  "business_name": "Tailsforce Ltd",
  "email": "sally@example.com",
  "industry_key": "construction",
  "is_show_kinde_branding": true,
  "phone": "123-456-7890",
  "privacy_url": "https://example.com/privacy",
  "terms_url": "https://example.com/terms",
  "timezone_key": "los_angeles_pacific_standard_time"
}

Response

Business successfully updated.

messagestring
codestring

Example response

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

Changes

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API

  • 6b937fa6da4eRevision changes
    • breaking

      added required request body

    • breaking

      removed the success response with the status

    • warning

      deleted the query request parameter business_name

    • warning

      deleted the query request parameter industry_key

    • warning

      deleted the query request parameter is_click_wrap

    • warning

      deleted the query request parameter is_show_kinde_branding

    • warning

      deleted the query request parameter partner_code

    • warning

      deleted the query request parameter primary_email

    • warning

      deleted the query request parameter primary_phone

    • warning

      deleted the query request parameter privacy_url

    • warning

      deleted the query request parameter terms_url

    • warning

      deleted the query request parameter timezone_id

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response status

    • info

      added the success response with the status