Listings APIListings API
로그인
POST/api/v4/social/posts/cancel

예약 게시물 취소

예약된 소셜 게시물을 게시되기 전에 취소하며, 이미 게시된 게시물은 변경하지 않습니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

본문

이름유형필수설명
inputobject필수Wrapper object. The entire request body must be nested under `input`.
input.socialPostIdstring필수UUID of the scheduled post to cancel.

요청 예시

바로 붙여 넣을 수 있는 본문입니다. 예시 ID와 값을 실제 값으로 바꾸세요.

Request body
{  "input": {    "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"  }}

응답

200The scheduled post was cancelled and will not publish.
Response
{  "data": {    "archiveScheduledPost": {      "success": true,      "error": null,      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
200The post was not in a cancellable state, most often because it has already published. The status is still 200: read `success`.
Response
{  "data": {    "archiveScheduledPost": {      "success": false,      "error": {        "message": "SY90006: Post is not scheduled and cannot be cancelled",        "code": "SY90006",        "contextInfo": null      },      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
401Unauthenticated, missing or invalid API key.
404No post with that ID on this account.

아직 게시 대기 중인 게시물을 취소합니다. 게시물은 ARCHIVED 상태로 전환되며 게시 파이프라인에서 제외됩니다. 초안도 같은 방식으로 취소할 수 있지만, 이미 게시된 게시물은 취소할 수 없습니다.

사용 사례: 고객이 마지막 순간에 캠페인을 철회하는 경우. 캘린더에 예약 게시물이 표시되어 있지만 고객이 마음을 바꾸면 자체 UI에서 해당 게시물을 취소합니다. 브랜드의 게시물 목록에서 게시물의 id를 그대로 가져와 이 엔드포인트를 호출하면 해당 행이 ARCHIVED 상태로 전환되고, 다음 조회 시 {"status":["SCHEDULED"]} 필터 결과에서 제외됩니다.

사용 사례: 채널 연결을 해제하기 전에 정리하는 경우. 연결을 해제해도 해당 연결에 이미 대기 중인 게시물은 취소되지 않습니다. 대신 게시 시점에 SY95045 오류로 실패합니다. 먼저 예약 게시물을 취소한 다음 연결을 해제하면 고객에게 실패가 전혀 표시되지 않습니다.

참고 사항.

  • 요청 본문은 반드시 input 객체로 감싸야 합니다.
  • HTTP 상태가 아니라 success를 확인합니다. 이미 게시되었거나 이미 취소된 게시물의 경우 success: false와 함께 HTTP 200을 반환합니다.
  • 이 작업은 삭제가 아닙니다. 어떤 플랫폼에서도 아무것도 제거되지 않습니다. 이미 게시된 게시물은 그대로 공개된 상태로 유지되며, 이 호출은 해당 게시물에 대해 success: false를 보고하기만 합니다. 소셜 게시물의 게시를 취소하는 엔드포인트는 없으며, 게시물을 제거하려면 해당 플랫폼에서 직접 처리해야 합니다.
  • 취소는 게시물의 모든 채널에 일괄 적용됩니다. 한 플랫폼에서만 예약 게시물을 취소하고 다른 플랫폼에서는 게시되도록 할 수는 없으므로, 이러한 동작이 필요하면 게시물을 별도로 생성합니다.
  • 이후에도 GET /social/posts/{postId}로 게시물을 조회할 수 있으며, post.status 값은 ARCHIVED입니다.

쓰기 작업: 실제 계정에서는 실행하지 않았습니다. 표시된 요청과 응답은 API 스키마를 기반으로 구성되었습니다.

Request
curl -X POST 'https://listingsapi.com/api/v4/social/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'
Run in playground