POST
/api/v4/social/brands/archiveブランドをアーカイブする
ブランドが90日間の在籍期間の条件を満たしている場合に、ソーシャルブランドをアーカイブし、その接続を即座にオフラインにします。接続枠は請求期間の終了まで保持されます。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input | object | 必須 | Wrapper object. The entire request body must be nested under `input`. |
| input.socialProfileId | string | 必須 | UUID of the brand to archive. Same value as the `brandId` path token used elsewhere. |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "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.
{ "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`.
{ "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オブジェクトでラップする必要があり、フィールドはbrandIdではなくsocialProfileIdです。 - HTTPステータスではなく、
successを確認してください。 90日の経過条件を満たさない場合は、success: false、status: "TENURE_NOT_MET"、およびerror内のSY95051を含むHTTP 200が返されます。 - ブランドをアーカイブするには、追加されてから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" } }'