DELETE/api/v4/posts/{postId}

게시물 삭제

소셜 게시물 캠페인을 영구적으로 삭제하고 게시된 모든 사이트에서 제거합니다.

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

매개변수

경로

이름유형필수설명
postIdstring필수Base64-encoded social post ID to delete (the `id` from a posts list or the create response).

본문

이름유형필수설명
clientMutationIdstring선택Optional client-supplied token returned unchanged in the response, for correlating the request.

요청 예시

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

Request body
{  "clientMutationId": "delete-44122-req-1"}

응답

200Post deleted. `socialPostId` returns the deleted post's ID.
Response
{  "data": {    "deleteSocialPost": {      "success": true,      "socialPostId": "U29jaWFsUG9zdDo0NDEyMg=="    }  }}
401Unauthenticated, missing or invalid API key.

지정한 게시물 캠페인을 삭제합니다. 이 작업은 영구적입니다. 게시물은 Listings API에서 제거되고 동시에 게시된 모든 사이트(Google, Facebook)에서 게시가 취소됩니다. 게시 중인 게시물을 삭제하면 연결된 프로필에서 내려가며, 되돌릴 수 없습니다.

사용 사례: 잘못된 공지 철회. 잘못된 영업시간이 포함된 공지가 게시된 경우, 게시물 목록의 id를 사용하여 DELETE /posts/{postId}로 삭제하고, success: true를 확인한 다음, POST /posts로 수정된 공지를 게시합니다. 모든 매장에서 캠페인을 한 번에 제거하려면 대신 일괄 ID로 일괄 캠페인을 삭제합니다.

참고 사항.

  • 요청 본문은 선택 사항입니다. 요청 간 연관 관계를 파악하기 위해 값을 변경 없이 반환받으려는 경우에만 clientMutationId를 전송합니다. 생성된 코드 스니펫에는 예시로 이 값이 포함되어 있습니다.
  • 예약된 게시 기간이 이미 끝난 게시물은 status: EXPIRED로 표시되고 각 사이트에서 이미 내려갔을 수 있지만, 삭제하면 Listings API에서는 제거됩니다.
  • 이미 삭제되었거나 알 수 없는 게시물을 삭제하면 success: true 대신 오류 응답({"data":null,"errors":[...]})이 반환됩니다.

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

Request
curl -X DELETE 'https://listingsapi.com/api/v4/posts/<postId>' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "clientMutationId": "delete-44122-req-1"  }'