MEmetorial
Integration Instances

Update integration instance

Updates a specific integration instance.

patch/integration-instances/{integration_instance_id}

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

integration_instance_idstring required

Unique identifier of the integration instance.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

namestring
descriptionstring nullable
metadataobject nullable
identity_actor_idstring nullable
identity_idstring nullable

Response

Successful response

object'integration.instance' required
idstring required
status'draft' | 'active' | 'archived' | 'deleted' required
namestring required
descriptionstring nullable required
metadataobject nullable required
integration_idstring required
identity_actor_idstring nullable required
identity_idstring nullable required
created_atstring date-time required
updated_atstring date-time required
archived_atstring date-time nullable required

Example response

{
  "providers": [
    {
      "provider": {
        "id": "pro_5gHjKlMnPqRsTuVw",
        "name": "GitHub",
        "description": "Connect to GitHub repositories, issues, and pull requests",
        "slug": "github",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "integration_provider": {
        "config": {
          "id": "pcf_7dEfGhJkLmNpQrSt",
          "name": "Production Config",
          "description": "Configuration for production environment",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        }
      },
      "config": {
        "id": "pcf_7dEfGhJkLmNpQrSt",
        "name": "Production Config",
        "description": "Configuration for production environment",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_config": {
        "id": "pcf_7dEfGhJkLmNpQrSt",
        "name": "Production Config",
        "description": "Configuration for production environment",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "callback_instance_id": "cbi_5gHjKlMnPqRsTuVw"
    }
  ]
}

Changes

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