Xeonr Developer Docs
UplApiIntegration Admin

Upsert integration metadata key

POST
/uplim.api.v1.IntegrationAdminService/UpsertIntegrationMetadataKey

Creates or updates a metadata key registration for an integration. The key local part is immutable after creation.

Authorization

OAuth2 upl:private
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:private

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

integrationId?string

The parent integration that owns this metadata key. Accepts a UUID or a slug (URN prefix). Server detects which by UUID-parse.

Length1 <= length
updateMask?string
metadataKeyId?string|null

Existing metadata key ID (omit for create)

Formatuuid
key?string|null

Immutable local part of the URN. Set on create; immutable thereafter.

Match^[a-z][a-z0-9._-]{0,62}[a-z0-9]$
Length2 <= length <= 64
title?string|null
Lengthlength <= 255
iconName?string|null
Lengthlength <= 64
valueType?MetadataValueType|null

enum.defined_only = true

hiddenFromUsers?boolean|null

validate:skip a bool has no bounds

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.IntegrationAdminService/UpsertIntegrationMetadataKey" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "metadataKey": {
    "id": "string",
    "integrationId": "string",
    "key": "string",
    "title": "string",
    "iconName": "string",
    "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
    "hiddenFromUsers": true,
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}