PEpermit
Organizations

Update Organization

Changed on

Updates the organization's profile.

patch/v2/orgs/{org_id}

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

org_idstring required

Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug").

Request body

namestring

The name of the organization, usually it's your company's name.

settingsobject

the settings for this project

Response

Successful Response

keystring required

A URL-friendly name of the organization (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the organization.

idstring uuid required

Unique id of the organization

is_enterpriseboolean required

Is this an enterprise account?

created_atstring date-time required

Date and time when the organization was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the organization was last updated/modified (ISO_8601 format).

namestring required

The name of the organization, usually it's your company's name.

settingsobject

the settings for this project

Changes

  • 05b99f06db87Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      the response's property default value changed from free to trial for the status

    • info

      the response's property default value changed from 1000 to 5000 for the status

    • info

      the response's property default value changed from 20 to 50 for the status

    • info

      the response's property default value changed from {"mau":1000,"tenants":20,"billing_tier":"free"} to {"mau":5000,"tenants":50,"billing_tier":"trial"} for the status