cURL
curl --request PATCH \
--url https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": [
"<string>"
],
"website_url": "<string>",
"app_store_url": "<string>",
"use_location_name": true,
"send_action_links": true
}
'import requests
url = "https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}"
payload = {
"brand_name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": ["<string>"],
"website_url": "<string>",
"app_store_url": "<string>",
"use_location_name": True,
"send_action_links": True
}
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({
brand_name: '<string>',
country_code: '<string>',
primary_category: '<string>',
additional_categories: ['<string>'],
website_url: '<string>',
app_store_url: '<string>',
use_location_name: true,
send_action_links: true
})
};
fetch('https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}', 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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}",
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([
'brand_name' => '<string>',
'country_code' => '<string>',
'primary_category' => '<string>',
'additional_categories' => [
'<string>'
],
'website_url' => '<string>',
'app_store_url' => '<string>',
'use_location_name' => true,
'send_action_links' => true
]),
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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}"
payload := strings.NewReader("{\n \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}")
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 \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"payload": {
"segment_id": "<string>",
"apple_company_id": "<string>",
"apple_brand_id": "<string>",
"abc_sync_status": "<string>",
"brand_name": "<string>",
"name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": [
"<string>"
],
"apple_categories": [
"<string>"
],
"website_url": "<string>",
"app_store_url": "<string>",
"ownership_type": "<string>",
"use_location_name": true,
"send_action_links": true,
"locations": [
"<string>"
],
"provision_source": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Apple Brands
Update Apple Brand
Updates a brand. All fields are optional (at least one is required). apple_company_id cannot change. primary_category is required whenever categories change.
PATCH
/
apple
/
brands
/
{segment_id}
cURL
curl --request PATCH \
--url https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": [
"<string>"
],
"website_url": "<string>",
"app_store_url": "<string>",
"use_location_name": true,
"send_action_links": true
}
'import requests
url = "https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}"
payload = {
"brand_name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": ["<string>"],
"website_url": "<string>",
"app_store_url": "<string>",
"use_location_name": True,
"send_action_links": True
}
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({
brand_name: '<string>',
country_code: '<string>',
primary_category: '<string>',
additional_categories: ['<string>'],
website_url: '<string>',
app_store_url: '<string>',
use_location_name: true,
send_action_links: true
})
};
fetch('https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}', 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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}",
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([
'brand_name' => '<string>',
'country_code' => '<string>',
'primary_category' => '<string>',
'additional_categories' => [
'<string>'
],
'website_url' => '<string>',
'app_store_url' => '<string>',
'use_location_name' => true,
'send_action_links' => true
]),
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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}"
payload := strings.NewReader("{\n \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\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.gmbapi.com/external-api/gmb/apple/brands/{segment_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gmbapi.com/external-api/gmb/apple/brands/{segment_id}")
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 \"brand_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"primary_category\": \"<string>\",\n \"additional_categories\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"app_store_url\": \"<string>\",\n \"use_location_name\": true,\n \"send_action_links\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"payload": {
"segment_id": "<string>",
"apple_company_id": "<string>",
"apple_brand_id": "<string>",
"abc_sync_status": "<string>",
"brand_name": "<string>",
"name": "<string>",
"country_code": "<string>",
"primary_category": "<string>",
"additional_categories": [
"<string>"
],
"apple_categories": [
"<string>"
],
"website_url": "<string>",
"app_store_url": "<string>",
"ownership_type": "<string>",
"use_location_name": true,
"send_action_links": true,
"locations": [
"<string>"
],
"provision_source": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Restricted. Requires Apple API access. Returns
403 with APPLE_API_DISABLED otherwise.Requires an Organization token.
apple_company_id cannot change. primary_category is required whenever categories change.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Brand segment id (brand-<uuid>)
Body
application/json
All fields optional; at least one is required. apple_company_id cannot change.
ISO 3166-1 alpha-2 country code.
Required string length:
2Required whenever categories change (stored values are never re-mapped).
Maximum array length:
19Available options:
BRAND_OWNER, FRANCHISEE false (default): locations display the brand name on Apple Maps. true: locations keep their own name.
Controls whether preferred Google action links are pushed as Apple quicklinks the next time a location is added.