Listings APIListings API
Masuk
POST/api/v4/social/brands/update

Memperbarui merek

Memperbarui nama, zona waktu, situs web, kategori, hashtag, atau bio merek di media sosial.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Body

NamaTipeWajibDeskripsi
inputobjectwajibWrapper object. Every field below is a property of `input`, the entire body must be nested under it.
input.profileIdstringwajibUUID of the brand to update. This is the same value used as the `brandId` path token elsewhere.
input.profileNamestringopsionalNew display name.
input.timezoneobjectopsionalNew timezone as `{ label, tzCode, name, utc }`. `tzCode` is the IANA identifier that schedules are resolved against.
input.businessIntentstringopsionalOne or two sentences describing what the business does.
input.categoriesarray of stringsopsionalBusiness categories. Replaces the stored list rather than merging into it.
input.siteUrlstringopsionalThe brand's website. Changing it queues a fresh read of the site.
input.logostringopsionalPublic https URL of the brand logo.
input.countryIsostringopsionalTwo-letter ISO country code.
input.biostringopsionalShort brand bio.
input.brandHashtagsarray of stringsopsionalReplaces the brand's hashtag list.
input.competitorHashtagsarray of stringsopsionalReplaces the competitor hashtag list.
input.contentPreferredLanguagestringopsionalPreferred language for generated content, e.g. `en`.

Contoh permintaan

Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.

Request body
{  "input": {    "profileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",    "profileName": "Jenny Home & Co.",    "siteUrl": "https://jennyhomeandco.example",    "brandHashtags": ["jennyhome", "handmadefurniture", "shoplocal"]  }}

Respons

200Brand updated. The full brand is returned.
Response
{  "data": {    "updateSocialProfile": {      "success": true,      "error": null,      "socialProfile": {        "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",        "profileName": "Jenny Home & Co.",        "archived": false,        "logo": null,        "profileLogo": null,        "siteUrl": "https://jennyhomeandco.example",        "countryIso": "US",        "bio": "Handmade furniture for real homes.",        "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",        "categories": ["Furniture Store", "Home Goods"],        "brandHashtags": ["jennyhome", "handmadefurniture", "shoplocal"],        "competitorHashtags": [],        "connectedChannelCount": 3,        "timezone": {          "label": "(GMT-05:00) Eastern Time",          "tzCode": "America/New_York",          "name": "Eastern Standard Time",          "utc": "-05:00"        },        "contentPreferredLanguage": "en"      }    }  }}
200Validation failed. The status is still 200: read `success`.
Response
{  "data": {    "updateSocialProfile": {      "success": false,      "error": {        "message": "SY95046: Unknown timezone",        "code": "SY95046",        "contextInfo": null      },      "socialProfile": null    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Mengedit merek yang sudah ada. Merek ditentukan melalui input.profileId dalam body, bukan melalui parameter path, sehingga rutenya berupa POST /social/brands/update tanpa parameter path.

Kasus penggunaan: menjaga agar merek tetap selaras dengan CRM Anda. Saat pelanggan mengganti nama bisnis atau memindahkan situs mereka, terapkan perubahan yang sama di sini agar header merek dan saran di editor postingan tetap akurat. Mengubah siteUrl juga menjadwalkan pembacaan ulang situs dalam antrean, sehingga saran menggunakan teks terbaru tanpa panggilan tambahan.

Catatan.

  • Body permintaan harus dibungkus dalam objek input.
  • Periksa success, bukan status HTTP. Pembaruan yang ditolak mengembalikan HTTP 200 dengan success: false dan alasannya dalam error.
  • Hanya profileId yang wajib diisi. Semua field lainnya bersifat opsional, sehingga pembaruan parsial dapat dilakukan: kirim hanya field yang Anda ubah dan field lainnya akan dibiarkan tetap seperti semula. Field pengenal di sini adalah profileId, bukan brandId — brandId hanya digunakan sebagai token path URL.
  • categories, brandHashtags, dan competitorHashtags diganti, bukan digabungkan, saat Anda mengirimkannya. Mengirim [] akan mengosongkan daftar.
  • Mengubah timezone memengaruhi cara nilai scheduleDate / scheduleTime di masa mendatang ditafsirkan. Postingan yang sudah dijadwalkan tetap menggunakan titik waktu yang telah ditentukan sebelumnya; waktunya tidak disesuaikan ulang. Baca kembali data merek dengan GET /social/brands/{brandId} untuk memastikannya.

Operasi tulis: tidak dijalankan pada akun aktif. Permintaan dan respons yang ditampilkan disusun berdasarkan skema API.

Request
curl -X POST 'https://listingsapi.com/api/v4/social/brands/update' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "profileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home & Co.",      "siteUrl": "https://jennyhomeandco.example",      "brandHashtags": [        "jennyhome",        "handmadefurniture",        "shoplocal"      ]    }  }'
Run in playground