メインコンテンツへスキップ
PATCH
/
media-bridge
/
v1
/
{appId}
/
schemas
/
{objectType}
Update the schema for an object type
curl --request PATCH \
  --url https://api.hubapi.com/media-bridge/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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

承認

Authorization
string
header
必須

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

パスパラメータ

appId
integer<int32>
必須
objectType
string
必須

ボディ

application/json
clearDescription
boolean
必須
allowsSensitiveProperties
boolean
description
string
labels
object
primaryDisplayProperty
string
requiredProperties
string[]
restorable
boolean
searchableProperties
string[]
secondaryDisplayProperties
string[]

レスポンス

successful operation

allowsSensitiveProperties
boolean
必須
archived
boolean
必須
fullyQualifiedName
string
必須
id
string
必須
labels
object
必須
name
string
必須
objectTypeId
string
必須
requiredProperties
string[]
必須
searchableProperties
string[]
必須
secondaryDisplayProperties
string[]
必須
createdAt
string<date-time>
description
string
portalId
integer<int32>
primaryDisplayProperty
string
updatedAt
string<date-time>
最終更新日 2026年4月13日