Orgs

Update an existing org by ID

Required scope - write_org

put/api/v1/orgs/{id}

Path parameters

idnumber required

The unique ID of the org

Request body

namestring
slugstring
allowPublicRegistrationboolean
onlyUseForBrandingOverrideboolean
companyLogoUrlstring
companyEmailLogoUrlstring
fontFamilystring
fontUrlstring
layoutColorstring
labelColorstring
primaryButtonColorstring
primaryButtonLabelColorstring
primaryButtonBorderColorstring
secondaryButtonColorstring
secondaryButtonLabelColorstring
secondaryButtonBorderColorstring
criticalIndicatorColorstring
emailSenderNamestring
termsLinkstring
privacyPolicyLinkstring

Response

Changes

Changed in 7 of the 50 revisions of this API.111

    • added the new optional request property onlyUseForBrandingOverride

      new-optional-request-property

    • added the required property org/onlyUseForBrandingOverride to the response with the 200 status

      response-required-property-added

    • added the new optional request property allowPublicRegistration

      new-optional-request-property

    • added the required property org/allowPublicRegistration to the response with the 200 status

      response-required-property-added

    • added the new optional request property companyEmailLogoUrl

      new-optional-request-property

    • added the required property org/companyEmailLogoUrl to the response with the 200 status

      response-required-property-added

    • added the new optional request property slug

      new-optional-request-property

    • added the required property org/slug to the response with the 200 status

      response-required-property-added

    • the privacyPolicyLink request property's maxLength was increased from 20 to 250

      request-property-max-length-increased

    • the termsLink request property's maxLength was increased from 20 to 250

      request-property-max-length-increased

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog