Sign in
Organization

Partial update organization

Update part of organization object. Writable fields are ui_settings, metadata, and settings; all other fields are read-only.

patch/api/v1/organizations/{organizationID}

Request body

idinteger

ID of the organization.

namestring

Name of the organization (not visible in UI).

urlstring uri

URL of the organization.

workspacesstring[]

List of workspaces objects in the organization.

usersstring[]

List of users in the organization.

organization_groupstring uri

URL to organization group the organization belongs to.

ui_settingsobject

Organization-wide frontend UI settings (e.g. locales). Rossum internal.

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

is_trialboolean

Property indicates whether this license is a trial license.

created_atstring date-time

Timestamp for when the organization was created.

trial_expires_atstring date-time nullable

Timestamp for when the trial period ended (ISO 8601).

oidc_providerstring nullable

(Deprecated) OpenID Connect provider name.

creatorstring uri nullable

URL of the first user of the organization (set during organization creation).

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

sandboxboolean

Specifies if the organization is a sandbox.

Example request

{
  "id": 406,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/organizations/406",
  "workspaces": [
    "https://example.rossum.app/api/v1/workspaces/7540"
  ],
  "users": [
    "https://example.rossum.app/api/v1/users/10775"
  ],
  "organization_group": "https://example.rossum.app/api/v1/organization_groups/17",
  "ui_settings": {},
  "metadata": {
    "some_key": "some_value"
  },
  "is_trial": true,
  "created_at": "2019-09-02T14:28:11.000000Z",
  "trial_expires_at": "2020-09-02T14:28:11.000000Z",
  "internal_info": {
    "cs_account_classification": null,
    "customer_type": null,
    "market_category": null,
    "overdue_payment_date": null,
    "sso_active": false
  },
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z",
  "settings": {}
}

Response

OK

idinteger required

ID of the organization.

namestring required

Name of the organization (not visible in UI).

urlstring uri required

URL of the organization.

workspacesstring[] required

List of workspaces objects in the organization.

usersstring[] required

List of users in the organization.

organization_groupstring uri required

URL to organization group the organization belongs to.

ui_settingsobject required

Organization-wide frontend UI settings (e.g. locales). Rossum internal.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

is_trialboolean required

Property indicates whether this license is a trial license.

created_atstring date-time required

Timestamp for when the organization was created.

trial_expires_atstring date-time nullable

Timestamp for when the trial period ended (ISO 8601).

oidc_providerstring nullable

(Deprecated) OpenID Connect provider name.

creatorstring uri nullable

URL of the first user of the organization (set during organization creation).

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

sandboxboolean required

Specifies if the organization is a sandbox.

Example response

{
  "id": 406,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/organizations/406",
  "workspaces": [
    "https://example.rossum.app/api/v1/workspaces/7540"
  ],
  "users": [
    "https://example.rossum.app/api/v1/users/10775"
  ],
  "organization_group": "https://example.rossum.app/api/v1/organization_groups/17",
  "ui_settings": {},
  "metadata": {
    "some_key": "some_value"
  },
  "is_trial": true,
  "created_at": "2019-09-02T14:28:11.000000Z",
  "trial_expires_at": "2020-09-02T14:28:11.000000Z",
  "internal_info": {
    "cs_account_classification": null,
    "customer_type": null,
    "market_category": null,
    "overdue_payment_date": null,
    "sso_active": false
  },
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z",
  "settings": {}
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.