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 객체로 감싸야 하며, 필드는 brandId가 아니라 socialProfileId입니다.
  • HTTP 상태가 아니라 success를 확인해야 합니다. 유지 기간 조건을 충족하지 못하면 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"    }  }'
Run in playground