고객 연락처 삭제 API

4 분 읽기가이드 기준일: 2026. 10. 14.노션 원문 보기 ↗

목적

이 API는 Sidetalk 고객 연락처에 저장된 고객정보를 삭제합니다.

삭제 대상은 memberId, sessionId, 또는 userInfoId로 지정할 수 있습니다.

URL

JavaScript

💡https://api.sidetalk.ai/v1/users/delete

HTTP 메서드

POST

헤더

헤더	값	설명
Content-Type	application/json	요청 본문이 JSON 형식임을 나타냅니다.
Authorization	Bearer <api_key>	Sidetalk 대시보드에서 설치하기 메뉴에 제공된 API 키를 사용하세요.

본문

파라미터	타입	필수	설명
memberId	String	조건부 필수	외부 서비스의 회원 고유 ID입니다.
sessionId	String	조건부 필수	대화 세션 ID입니다.
userInfoId	String	조건부 필수	Sidetalk 고객정보 ID입니다.

memberId, sessionId, userInfoId 중 하나는 반드시 포함해야 합니다.

요청 예시

member_id로 삭제

JavaScript

curl -X POST https://api.sidetalk.ai/v1/users/delete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
      "memberId": "user_123"
  }'

여러 member_id 삭제

JavaScript

curl -X POST https://api.sidetalk.ai/v1/users/delete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
      "memberIds": ["user_123", "user_456"]
  }'

user_info_id로 삭제

JavaScript

curl -X POST https://api.sidetalk.ai/v1/users/delete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
      "userInfoId": "123"
  }'

응답 본문

JavaScript

{
  "success": true,
  "deletedCount": 1,
  "matchType": "member_id"
}

응답 필드 설명

필드	타입	설명
success	Boolean	삭제 성공 여부입니다.
deletedCount	Number	삭제된 고객정보 개수입니다.
matchType	String	삭제 기준입니다. member_id, session_id, user_info_id 중 하나입니다.

삭제 대상이 없는 경우

JavaScript

{
  "success": false,
  "deletedCount": 0,
  "matchType": "member_id"
}

오류 응답

JavaScript

{
  "success": false,
  "error": "member_id, session_id, or user_info_id is required."
}

필드	타입	설명
success	Boolean	요청 실패 여부입니다.
error	String	오류 메시지입니다.

참고 사항

삭제는 API 키에 연결된 사이트의 고객정보에만 적용됩니다.
공개 API에서는 전체 고객정보 삭제 기능을 제공하지 않습니다.
여러 건을 삭제하려면 memberIds, sessionIds, userInfoIds 배열을 사용할 수 있습니다.
하위 호환 및 외부 서비스 연동 편의를 위해 다음 별칭 필드도 지원됩니다.

대표 필드	지원 별칭
userInfoId	user_info_id, user_info_ids, id
userInfoIds	user_info_ids
memberId	member_id
memberIds	member_ids
sessionId	session_id
sessionIds	session_ids