Organizations

Update organization name

Changed on
put/api/v1/organizations/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/organizations/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Organization ID

Request body text/plain

string required

Response

Organization updated

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

    • info

      api operation id update_org_name removed and replaced with update_organization

    • breaking

      added subschema #1: Community subschema #2: Free subschema #3: Starter subschema #4: Pro subschema #5: Team subschema #6: Business subschema #7: Enterprise subschema #8: Demo subschema #9: CommercialSelfHosted subschema #10: SelfHostedStandard subschema #11: SelfHostedPlus to the ///// response property oneOf list for the response status

    • info

      removed subschema #2 from the ///// response property oneOf list for the response status