Update Unified Model

Update an existing unified model. You can rename it, modify its category, or update resource definitions, etc.

Endpoint

http

PATCH /unified-model/{id}

Path parameters

string · uuid

REQUIRED ·

The ID of the unified model to update.

Example: 7c5c8cc2-e68e-4af8-84d1-4ceea1489338

Request Body

name

string

The new name of the unified model, if you want to rename it.

Example: user-directory

Response Body

string · uuid

The ID of the unified model.

Example: 7c5c8cc2-e68e-4af8-84d1-4ceea1489338

name

string

The name of the unified model.

Example: user-directory

category

string

The category of the unified model.

Example: hris

description

string

A brief description of what this unified model represents.

Example: This model provides a user directory interface for various HRIS integrations.

team_id

string · uuid

The ID of the team that owns this unified model.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

sharing

string

The sharing policy of the unified model.

All possible enum values:

allow
ask
deny

Example: deny

resources

object

A map of resource names to schema and integration mapping details.

Example:

{
  "users": {
    "description": "A resource representing user objects",
    "schema": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "integration_mapping": {
      "my_integration": {
        "list": {
          "resource": "/users",
          "method": "get"
        }
      }
    }
  }
}

docs

object

Optional documentation or instructions for each resource.

scopes

object

Optional OAuth/permission scopes or other relevant scopes for this unified model.

webhooks

object

Optional webhook definitions for this unified model.

created_at

string · date-time

The date and time when the unified model was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the unified model was last updated.

Example: 2021-08-10T10:30:00.000Z

version

number

The current version of the unified model.

Example: 3

installed_environment

string[]

A list of environment IDs where this unified model is installed.

team

object

The team object that owns this unified model.

string · uuid

The ID of the team.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

name

string

The name of the team.

Example: My Awesome Team

domain

string

The domain of the team.

Example: example.com

logo

string

The URL of the team's logo.

Example: https://example.com/logo.png

is_verified

boolean

Whether the team is verified or not.

Example: true

is_white_label

boolean

Whether the team is white-labeled or not.

tos_link

string

A link to the team's Terms of Service, if available.

Example: https://example.com/tos

allow_impersonation

boolean

Whether the team allows impersonation.

created_at

string · date-time

The date and time when the team was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the team was last updated.

Example: 2021-08-10T10:00:00.000Z