Listings APIListings API
登入
POST/api/v4/social/brands/archive

封存品牌

在品牌符合 90 天的存續期限規則後，封存社群品牌，並立即讓其連線離線；連線名額會保留至計費週期結束。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

請求主體

名稱類型必填說明
inputobject必填Wrapper object. The entire request body must be nested under `input`.
input.socialProfileIdstring必填UUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

請求範例

可直接貼上的請求主體。請將預留位置 ID 與值換成您自己的。

Request body
{  "input": {    "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"  }}

回應

200Brand archived. Its connections are archived with it and go offline at once, but their slots stay counted against `maxConnections` until the billing period ends.
Response
{  "data": {    "archiveSocialProfile": {      "success": true,      "error": null,      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "ARCHIVED"    }  }}
200The brand is less than 90 days old and cannot be archived yet. `success` is `false` and `status` is `TENURE_NOT_MET`.
Response
{  "data": {    "archiveSocialProfile": {      "success": false,      "error": {        "message": "SY95051: Brand must be at least 90 days old before it can be archived",        "code": "SY95051",        "contextInfo": null      },      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "TENURE_NOT_MET"    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

封存品牌。封存會立即生效：品牌在帳戶中存在至少 90 天後，此呼叫會在同一個請求中封存品牌及其連結的所有社群帳號，這些帳號也會立即停止發布內容。

使用案例：規劃下一個週期的容量。品牌本身沒有數量限制，也不按用量計費，因此封存的重點在於連線，而非品牌數量。如果客戶已流失，封存其品牌會讓其管道當天離線，並將名額排定於續訂時釋出，這正是 GET /social/limits 中的 usage.connectionsReleased 所呈現的資訊。如果您在此之前就需要容量，請購買連線套組，這是唯一會立即生效的變更。

回應中的狀態值：

  • ARCHIVED：品牌及其連線已封存。這是唯一的成功結果。
  • TENURE_NOT_MET：品牌存在的時間未滿 90 天，目前尚無法封存。success 為 false，error.code 為 SY95051，且品牌維持不變。

注意事項。

  • 請求主體必須包在 input 物件中，且欄位為 socialProfileId，不是 brandId。
  • 請檢查 success，而非 HTTP 狀態。未符合存續期限要求時，會傳回 HTTP 200，並包含 success: false、status: "TENURE_NOT_MET"，以及 error 中的 SY95051。
  • 品牌必須存在至少 90 天才能封存。地點也適用相同規則；請參閱方案與加購項目。請在品牌存在滿 90 天後重試；無法透過 API 豁免此規則。
  • 封存品牌也會封存其連線。連結至品牌的每個社群帳號都會在同一次操作中中斷連線，而 GET /social/limits 會在下次讀取時反映此變更，呈現較低的 usage.connectionsActive 與較高的 usage.connectionsReleased。計費用的 usage.connections 在進入下一個週期前維持不變。
  • 品牌沒有可取消的項目。封存本身不會等到計費週期結束才生效，因此沒有排程狀態，也沒有用於取消封存的呼叫。確實會延後的是計費上的影響：解除連線所釋出的名額，與已取消的套組一樣，會在週期結束時歸還。

寫入操作：未對正式帳戶執行。此處顯示的請求與回應是根據 API 結構描述建構的。

Request
curl -X POST 'https://listingsapi.com/api/v4/social/brands/archive' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"    }  }'
Run in playground