사업장에서 등록 정보 연결 해제

매개변수

본문

이름	유형	필수	설명
input	object	필수	Wrapper object. The entire request body must be nested under `input`.
input.locationId	string	필수	Base64-encoded Relay ID of the one location to disconnect.
input.site	string	선택	Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerId	string	선택	The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Listings API 사업장과 현재 연결된 게시 플랫폼 등록 정보(Google Business Profile, Facebook Page 또는 Apple Business Connect) 간의 연결을 제거합니다. 연결을 해제하면 Listings API는 해당 등록 정보에 업데이트를 더 이상 전송하지 않습니다. 사업장 자체는 계정에 유지되며, 등록 정보와의 연결만 끊어집니다.

요청 형식. 본문은 단일 locationId와 함께, 해제할 연결을 지정하는 site(GOOGLE, FACEBOOK 또는 APPLE) 또는 providerId 둘 중 하나를 포함하는 input 객체로 감싸야 합니다. 이 엔드포인트는 일괄 처리용이 아니며 호출당 사업장 1개만 처리하므로, 여러 사업장을 처리하려면 반복 호출해야 합니다.

site와 providerId를 모두 보내지 않으면 SY10056("사업장 연결 해제에 유효한 사이트가 아닙니다")을 반환합니다. 사업장에 해당 사이트의 활성 연결이 없으면 별도 알림 없이 성공으로 처리하는 대신 SY10057("사업장이 해당 사이트에 연결되어 있지 않습니다")을 반환하므로, success: true는 실제로 연결이 제거되었음을 의미합니다.

사용 사례: 사업장을 다른 계정에 다시 연결. 고객이 매장을 한 Google 계정에서 다른 Google 계정으로 이전하는 경우, 먼저 여기에서 site: "GOOGLE"로 사업장의 현재 등록 정보 연결을 해제한 다음, 새로 연결된 계정에서 trigger-matches와 connect-listing을 사용하여 올바른 등록 정보에 연결합니다.

사용 사례: 삭제 없이 서비스 이용 종료. 고객이 요금제를 다운그레이드하여 더 이상 Listings API로 Google/Facebook 등록 정보를 관리하고 싶지 않지만 사업장 레코드와 Listings API에 호스팅된 해당 데이터를 유지하려는 경우, 사업장을 보관 처리하는 대신 등록 정보의 연결을 해제합니다. 이렇게 하면 다른 게시 플랫폼에서 사용할 사업장은 유지하면서 외부로 전송하는 동기화를 중단합니다.

이 엔드포인트는 실제 운영 중인 연결을 변경하고 해당 변경 사항을 게시 플랫폼에 전송합니다. 위의 샘플 요청과 응답은 예시입니다.

curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-listing' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" } }'

매개변수

본문

요청 예시

응답