이 페이지는 Relate API의 모든 리소스 엔드포인트를 한곳에 모았습니다. 인증·Base URL·페이지네이션 등 공통 사항은 소개를 참고하세요.
Relate API로 연락처(Contact)를 조회·생성·수정·삭제합니다.
모든 연락처 조회
연락처 단건 조회
이메일로 연락처를 찾을 수도 있습니다.
핸드폰 번호로도 찾을 수 있습니다. 입력한 번호는 저장 시점과 동일하게 정규화되므로, +821012345678, 01012345678, 010-1234-5678 등 어떤 형식으로 보내도 같은 연락처에 매칭됩니다.
연락처 생성
first_name, 또는 emails에 유효한 주소가 최소 1개 필요합니다.
organization_id를 "auto"로 전달하면, 이메일 도메인과 일치하는 기존 조직에 매칭되며, 없으면 해당 도메인으로 새 조직이 생성됩니다.
organization_id를 지정하지 않으면 조직 없이 연락처가 생성됩니다.
연락처 수정
연락처 이메일 삭제
연락처 삭제
조직 (Organizations)
Relate API로 조직(Organization)을 조회·생성·수정·삭제합니다.
모든 조직 조회
조직 단건 조회
조직 생성
name, 또는 domains에 유효한 URL이 최소 1개 필요합니다.
조직 수정
조직 도메인 삭제
조직 삭제
노트 (Notes)
Relate API로 노트(Note)를 조회·생성·수정·삭제합니다.
모든 노트 조회
노트 단건 조회
노트 생성
organization_id와 body는 필수입니다.
노트 수정
deal_id와 body만 수정할 수 있습니다.
노트 삭제
커스텀 필드 (Custom Fields)
Relate API로 커스텀 필드(Custom Field)를 조회·생성·수정·삭제합니다.
모든 커스텀 필드 조회
커스텀 필드 단건 조회
커스텀 필드 생성
name, model은 필수입니다.
model은 "organization", "contact", "deal" 중 하나여야 합니다.
data_type은 "text", "textarea", "url", "number", "date", "datetime", "select", "user", "contact" 중 하나여야 합니다. (생략 시 "text")
data_type이 "select"면 options가 필수입니다.
data_type이 "select", "user", "contact" 중 하나면 accepts_multiple_values가 필수입니다.
커스텀 필드 수정
name과 options만 수정할 수 있습니다.
커스텀 필드 삭제
리스트 / 프로세스 (Lists & Processes)
Relate API로 리스트(List)와 프로세스(Process)를 조회·생성·수정·삭제합니다. process 값으로 일반 리스트(false)와 프로세스(true)를 구분합니다.
모든 리스트/프로세스 조회
리스트/프로세스 단건 조회
일반 리스트 응답:
프로세스 응답:
리스트 생성
name (필수): 리스트 이름
process (필수): 프로세스 여부 (true=프로세스, false=일반 리스트)
entry_type (필수): 엔트리 유형. "Contact" 또는 "Organization"
fields (선택): 엔트리에 대한 커스텀 필드 정의 배열
name (필수): 필드 이름
data_type (필수): text, textarea, url, number, date, datetime, select, user, contact 중 하나
accepts_multiple_values (select/user/contact일 때 필수): 다중 값 허용 여부
options (select일 때 필수): 선택 옵션 배열
프로세스 생성
name (필수): 프로세스 이름
process (필수): 프로세스임을 나타내기 위해 true로 설정
entry_type (필수): 엔트리 유형. "Contact" 또는 "Organization"
identifier (필수): 엔트리를 고유하게 식별하는 값 (예: "DEAL")
duplicates_allowed (필수): 동일 식별자를 가진 엔트리 중복 허용 여부
statuses (선택): 상태 단계 배열. 각 항목은 다음을 포함
name (필수): 단계 라벨 (예: "Onboarding")
type (필수): active, won, lost 중 하나
entry_label (선택): 개별 엔트리 라벨 (예: "Lead", "Candidate")
status_label (선택): 상태 필드 라벨 (예: "Stage", "Status")
fields (선택): 추가 커스텀 필드 배열 (리스트 생성과 동일한 형식)
리스트/프로세스 수정
entry_type과 process는 수정할 수 없습니다.
리스트/프로세스 삭제
엔트리 (Entries)
**엔트리(Entry)**는 리스트 또는 프로세스에 속한 개별 항목입니다 (리스트 / 프로세스 참고). 모든 엔트리 엔드포인트는 해당 엔트리가 속한 리스트/프로세스의 ID인 :list_id 하위에 위치합니다.
리스트의 모든 엔트리 조회
일반 리스트 엔트리 응답:
프로세스 엔트리 응답:
엔트리 단건 조회
엔트리 생성
entryable_id (필수): 연결할 리소스(Contact 또는 Organization)의 ID
entryable_type (필수): "Contact" 또는 "Organization"
status (프로세스에서만 필수): 부여할 상태 이름 (프로세스에 존재해야 함)
assignee_email: 엔트리를 할당할 사용자 이메일
one_time_value_cents (프로세스에서만 필수): 일회성 금액 (cents)
recurring_value_cents (프로세스에서만 필수): 반복 금액 (cents)
recurring_value_period (프로세스에서만 필수): monthly, annual, one_time 중 하나
contact_id (선택): 조직과 연결된 contact의 ID
list_fields (선택): 리스트에 정의된 커스텀 필드
name: 필드 이름
value: 단일 값 또는 배열(다중 값 허용 필드인 경우)
엔트리 수정
entryable_id과 entryable_type는 수정할 수 없습니다.
엔트리 삭제
SMS / LMS
Relate API로 SMS·LMS 문자 메시지를 발송하고 조회합니다.
POST /v1/sms_messages — 단건 SMS/LMS 발송
GET /v1/sms_messages/:id — 단건 조회
GET /v1/sms_messages — 목록 조회 (페이지네이션)
SMS 발송
LMS 발송 (제목 포함)
메시지 단건 조회
메시지 목록 조회
파라미터
캘린더 이벤트 (Calendar Events)
캘린더 이벤트는 Google / Outlook 캘린더에서 동기화됩니다. 본 엔드포인트들은 read-only이며, 녹음(recording)이 1건 이상 완료된 회의만 노출됩니다.
모든 캘린더 이벤트 조회
회의 시작 시각이 늦은 순(최신순)으로 정렬되어 반환됩니다.
first (선택): 페이지 크기, 기본값 25
after (선택): offset. 이전 응답의 pagination.end_cursor 값을 그대로 전달
updated_after (선택): unix timestamp. 해당 시점 이후 업데이트된 회의만
starts_after (선택): unix timestamp. 회의 시작 시각이 이 값 이상
starts_before (선택): unix timestamp. 회의 시작 시각이 이 값 미만
contact_id (선택): contact hashid. 해당 contact가 참석자로 포함된 회의만
organization_id (선택): organization hashid. 해당 조직 소속 contact가 참석자로 포함된 회의만
캘린더 이벤트 단건 조회
상세 응답에는 첨부된 recording의 요약 정보(recordings 배열)가 포함됩니다. summary / transcript 등 상세 필드는 녹음 단건 조회 API로 별도 호출합니다.
녹음 (Recordings)
Recording은 Relate 노트테이커가 회의에 참여해 자동으로 생성합니다. 본 엔드포인트는 read-only이며, 목록 엔드포인트는 제공하지 않습니다 (recording 목록은 캘린더 이벤트 응답의 recordings 배열로 노출됩니다).
녹음 단건 조회
status가 done이 아니면 summary와 transcript가 null로 반환됩니다. 처리가 완료되면 위와 같이 채워집니다.
summary 객체의 키 구성은 워크스페이스의 summary 설정에 따라 다를 수 있습니다 (예시는 기본값 기준).