메일리의 API를 이용하면 구독자를 관리하고, 자동 이메일을 실행하며, 뉴스레터 데이터를 조회할 수 있습니다. 서버 간(서버-to-서버) 요청만 가능하며, HTML 폼에서의 직접 요청은 허용되지 않습니다.
기본 정보
- Base URL: https://api.maily.so
- 인증: 모든 요청에는 Authorization: Bearer {API_KEY} 헤더가 필요합니다.
- 요청 제한: 초당 최대 20회 요청 가능 (초과 시 status 429 응답)
구독자 목록 조회
- 엔드포인트: GET /api/{newsletter_id}/subscriptions.json
- 설명: 최신순으로 구독자 목록을 조회합니다.
- 파라미터:
- page (선택) : 페이지 이동을 위한 번호
구독자 신규 등록
- 엔드포인트: POST /api/{newsletter_id}/subscriptions.json
- 설명: 새로운 구독자를 등록하고 웰컴 레터를 발송합니다.
- 파라미터:
- email (필수) : 구독자 이메일
- name (선택) : 구독자 닉네임
- welcome_letter (선택, 기본값 true) : 웰컴 레터 발송 여부
- marketing_agreement (선택) : 마케팅 동의 여부
구독자 정보 수정
- 엔드포인트: PUT /api/{newsletter_id}/subscriptions/update_if_exist.json
- 설명: 기존 구독자의 정보를 수정합니다.
- 파라미터:
- email (필수) : 수정할 구독자의 이메일
- name (선택) : 닉네임 변경
- marketing_agreement (선택) : 마케팅 동의 여부
구독자 삭제 (구독 취소)
- 엔드포인트: POST /api/{newsletter_id}/subscriptions/cancel.json
- 설명: 구독을 취소합니다.
- 파라미터:
- email (필수) : 구독 취소할 이메일
그룹에 구독자 추가
- 엔드포인트: POST /api/{newsletter_id}/subscription_groups/:subscription_group_ext_id/add_subscriber.json
- 설명: 특정 그룹에 구독자를 추가합니다.
- 파라미터:
- email (필수) : 추가할 구독자 이메일
그룹에서 구독자 제외
- 엔드포인트: POST /api/{newsletter_id}/subscription_groups/:subscription_group_ext_id/remove_subscriber.json
- 설명: 특정 그룹에서 구독자를 제외합니다.
- 파라미터:
- email (필수) : 제외할 구독자 이메일
자동 이메일 조건 실행
- 엔드포인트: POST /api/{newsletter_id}/automated_emails/:automated_email_ext_id/trigger.json
- 설명: 특정 구독자에게 자동 이메일을 실행합니다.
- 파라미터:
- automated_email_trigger_ext_id (필수) : 실행할 자동 이메일 트리거 ID
- email (필수) : 이메일을 받을 구독자
이메일 목록 조회
- 엔드포인트: GET /api/{newsletter_id}/notes.json
- 설명: 뉴스레터의 이메일 목록을 최신순으로 조회합니다.
- 파라미터:
- page (선택) : 페이지 번호
- status (선택) : 뉴스레터 상태 (예: published)
- order_by (선택, 기본값 created_at) : 정렬 기준 (예: published_at)
📌 자세한 API 안내 및 응답, 에러 처리 등은 로그인 하신 후 '개발자 API' 메뉴에서 확인하실 수 있습니다.
