Update the schema for an object type

Schema aktualisieren

curl --request PATCH \
  --url https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearDescription": true,
  "allowsSensitiveProperties": true,
  "description": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "primaryDisplayProperty": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "restorable": true,
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ]
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}"

payload = {
    "clearDescription": True,
    "allowsSensitiveProperties": True,
    "description": "<string>",
    "labels": {
        "plural": "<string>",
        "singular": "<string>"
    },
    "primaryDisplayProperty": "<string>",
    "requiredProperties": ["<string>"],
    "restorable": True,
    "searchableProperties": ["<string>"],
    "secondaryDisplayProperties": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clearDescription: true,
    allowsSensitiveProperties: true,
    description: '<string>',
    labels: {plural: '<string>', singular: '<string>'},
    primaryDisplayProperty: '<string>',
    requiredProperties: ['<string>'],
    restorable: true,
    searchableProperties: ['<string>'],
    secondaryDisplayProperties: ['<string>']
  })
};

fetch('https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'clearDescription' => true,
    'allowsSensitiveProperties' => true,
    'description' => '<string>',
    'labels' => [
        'plural' => '<string>',
        'singular' => '<string>'
    ],
    'primaryDisplayProperty' => '<string>',
    'requiredProperties' => [
        '<string>'
    ],
    'restorable' => true,
    'searchableProperties' => [
        '<string>'
    ],
    'secondaryDisplayProperties' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}"

	payload := strings.NewReader("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allowsSensitiveProperties": true,
  "archived": true,
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "portalId": 123,
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

PATCH

media-bridge

2026-03

{appId}

schemas

{objectType}

Schema aktualisieren

curl --request PATCH \
  --url https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearDescription": true,
  "allowsSensitiveProperties": true,
  "description": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "primaryDisplayProperty": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "restorable": true,
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ]
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}"

payload = {
    "clearDescription": True,
    "allowsSensitiveProperties": True,
    "description": "<string>",
    "labels": {
        "plural": "<string>",
        "singular": "<string>"
    },
    "primaryDisplayProperty": "<string>",
    "requiredProperties": ["<string>"],
    "restorable": True,
    "searchableProperties": ["<string>"],
    "secondaryDisplayProperties": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clearDescription: true,
    allowsSensitiveProperties: true,
    description: '<string>',
    labels: {plural: '<string>', singular: '<string>'},
    primaryDisplayProperty: '<string>',
    requiredProperties: ['<string>'],
    restorable: true,
    searchableProperties: ['<string>'],
    secondaryDisplayProperties: ['<string>']
  })
};

fetch('https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'clearDescription' => true,
    'allowsSensitiveProperties' => true,
    'description' => '<string>',
    'labels' => [
        'plural' => '<string>',
        'singular' => '<string>'
    ],
    'primaryDisplayProperty' => '<string>',
    'requiredProperties' => [
        '<string>'
    ],
    'restorable' => true,
    'searchableProperties' => [
        '<string>'
    ],
    'secondaryDisplayProperties' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}"

	payload := strings.NewReader("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-03/{appId}/schemas/{objectType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allowsSensitiveProperties": true,
  "archived": true,
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "portalId": 123,
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Autorisierungen

Authorization

string

header

erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Pfadparameter

appId

integer<int32>

erforderlich

Die eindeutige ID der App, die dem Schema zugeordnet ist.

objectType

string

erforderlich

Der Objekttyp, dessen Schema aktualisiert wird.

Body

application/json

clearDescription

boolean

erforderlich

Ein boolescher Wert, der angibt, ob die Beschreibung gelöscht oder zurückgesetzt werden soll.

allowsSensitiveProperties

boolean

Ein boolescher Wert, der angibt, ob der Objekttyp Eigenschaften zulässt, die als vertraulich markiert sind.

description

string

Eine Zeichenfolge, die eine Beschreibung des Objekttyps enthält.

labels

object

Show child attributes

primaryDisplayProperty

string

Eine Zeichenfolge, die die primäre Eigenschaft identifiziert, die zur Anzeige des Objekts verwendet wird.

requiredProperties

string[]

Ein Array von Zeichenfolgen, das angibt, welche Eigenschaften für den Objekttyp erforderlich sind.

restorable

boolean

Ein boolescher Wert, der angibt, ob der Objekttyp nach dem Löschen wiederhergestellt werden kann.

searchableProperties

string[]

Ein Array von Zeichenfolgen, das angibt, welche Eigenschaften in Suchanfragen verwendet werden können.

secondaryDisplayProperties

string[]

Ein Array von Zeichenfolgen, die zusätzliche Eigenschaften auflisten, die zur Anzeige des Objekts verwendet werden.

Antwort

successful operation

allowsSensitiveProperties

boolean

erforderlich

Ein boolescher Wert, der angibt, ob der Objekttyp sensible Eigenschaften zulässt.

archived

boolean

erforderlich

Ein boolescher Wert, der angibt, ob der Objekttyp archiviert ist.

fullyQualifiedName

string

erforderlich

Eine Zeichenfolge, die den vollständig qualifizierten Namen des Objekttyps darstellt.

string

erforderlich

Eine Zeichenfolge, die die eindeutige ID für den Objekttyp darstellt.

labels

object

erforderlich

Show child attributes

name

string

erforderlich

Eine Zeichenfolge, die den Namen des Objekttyps darstellt.

objectTypeId

string

erforderlich

Eine Zeichenfolge, die die eindeutige ID für den Objekttyp innerhalb des Systems darstellt.

requiredProperties

string[]

erforderlich

Ein Array von Zeichenfolgen, die die für diesen Objekttyp erforderlichen Eigenschaften darstellen.

searchableProperties

string[]

erforderlich

Ein Array von Zeichenfolgen, das angibt, welche Eigenschaften in Suchvorgängen verwendet werden können.

secondaryDisplayProperties

string[]

erforderlich

Ein Array von Zeichenfolgen, die zusätzliche Eigenschaften zur Anzeige dieses Objekttyps darstellen.

createdAt

string<date-time>

Eine Zeichenfolge, die Datum und Uhrzeit der Erstellung des Objekttyps im ISO 8601-Format darstellt.

description

string

Eine Zeichenfolge, die eine Beschreibung des Objekttyps enthält.

portalId

integer<int32>

Eine Ganzzahl, die die Portal-ID darstellt, die dem Objekttyp zugeordnet ist.

primaryDisplayProperty

string

Eine Zeichenfolge, die die primäre Eigenschaft darstellt, die zur Anzeige dieses Objekttyps verwendet wird.

updatedAt

string<date-time>

Eine Zeichenfolge, die Datum und Uhrzeit der letzten Aktualisierung des Objekttyps im ISO 8601-Format darstellt.

Zuletzt geändert am 1. April 2026

⌘I

Account & Einstellungen

App-Verwaltung

Authentifizierung

Automatisierung

CMS

Kommunikationseinstellungen

Konversationen

CRM

Veranstaltungen

Dateien

Marketing

Zeitplaner

Webhooks

Update the schema for an object type

Autorisierungen

Pfadparameter

Body

Antwort