메인 콘텐츠로 건너뛰기
POST

인증

Authorization
string
header
필수

Settings → Developers에서 발급한 키를 Authorization: Bearer dr_live_<12자리 16진수>_<64자리 16진수> 형태로 전송합니다. 키는 명시적인 범위를 가지며 — 각 엔드포인트에 필요한 범위가 해당 엔드포인트에 명시되어 있습니다. 전체 키는 발급 시점에 딱 한 번만 표시되며 다시 조회할 수 없습니다 — 이후에는 keyId 접두어만 표시됩니다. 폐기된 키는 바로 다음 요청부터 인증에 실패합니다.

헤더

Idempotency-Key
string
필수

이 생성 시도를 식별하는 클라이언트 생성 고유 문자열(255자 이하)입니다. 위의 "멱등성" 항목을 참고하세요.

Maximum string length: 255

본문

application/json
commentReply
object
필수

일치하는 댓글 아래에 DocuRise가 남기는 공개 답글입니다. 댓글마다 변형 하나가 무작위로 선택됩니다. 필수입니다 — 공개 답글을 달지 않으려면 { "enabled": false }를 보내세요.

dm
object
필수

댓글 작성자가 받는 메인 DM입니다.

status
enum<string>
기본값:active

active(기본값)는 규칙을 활성화해 다음 게시물을 기다리게 합니다. paused는 일시정지된 상태로 저장하며, PATCH와 { "status": "active" }로 재개하기 전까지는 아무것도 전송되지 않습니다. schedule.batchSendAt과 함께 쓸 수 없습니다(422 BATCH_RULE_NOT_PAUSABLE).

사용 가능한 옵션:
active,
paused
target
object

규칙이 적용되는 대상입니다. 선택 사항이며, 현재는 계정의 다음 새 게시물만 지원하므로 생략하면 { "type": "next_post" }와 같습니다.

type
enum<string>
기본값:standard

규칙 유형입니다. 선택 사항입니다. 현재 API로는 standard(키워드 댓글 → DM)만 생성할 수 있습니다.

사용 가능한 옵션:
standard
keywords
string[]

댓글이 키워드 중 하나를 포함하면 규칙이 작동합니다 — 대소문자를 구분하지 않는 부분 문자열 일치이므로, guide는 "Guide please!"와도 일치합니다. 비어 있으면 모든 댓글에 작동하며, 한 게시물에 키워드 규칙과 전체 댓글 규칙이 모두 있으면 키워드 규칙이 일치할 때 키워드 규칙이 우선합니다.

Maximum array length: 20
Required string length: 1 - 50
greeting
object

첫 번째 DM으로, 이어가기 버튼 하나가 달린 메시지입니다. 댓글 작성자가 버튼을 누르면 Instagram 메시지 창이 열리고 메인 DM이 전달됩니다. enabled가 false이면 메인 DM이 비공개 답장으로 바로 발송됩니다. message / buttonText를 비워 두면 DocuRise의 기본 문구를 사용합니다.

schedule
object

선택적 일정입니다. 운영 기간(startAt / endAt) 또는 단일 일괄 발송(batchSendAt) 중 하나만 지정하며, 둘을 함께 지정할 수는 없습니다. "항상 켜짐"으로 두려면 생략하세요. "다음 게시물" 규칙의 경우 기간은 규칙이 새 게시물에서 활성화될 때 적용되며, 그 시점에 이미 끝난 기간은 버려지고 규칙은 그대로 시작됩니다.

locale
enum<string>

DocuRise 기본 문구(비워 둔 인사와 버튼 텍스트)의 언어입니다. 기본값은 계정의 언어입니다.

사용 가능한 옵션:
en,
ko

응답

규칙이 생성되었습니다. 상태는 waiting_for_post(다음 게시물을 기다림)이거나, 일시정지로 요청했다면 paused입니다.

id
string<uuid>
필수

새 규칙의 id입니다.

url
string<uri>
필수

대시보드 편집기에서 해당 규칙으로 연결되는 링크입니다.

status
enum<string>
필수

활성 규칙(기본값)은 waiting_for_post, status: paused로 생성했다면 paused입니다.

사용 가능한 옵션:
waiting_for_post,
paused
type
string
필수

규칙 유형입니다. API로 만든 규칙은 standard입니다.

target
object
필수

규칙이 적용되는 대상입니다.