Skip to main content
GET
Get an Instagram DM rule

Authorizations

Authorization
string
header
required

A key generated from Settings → Developers, sent as Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the keyId prefix is shown afterward. A revoked key fails auth on its very next request.

Path Parameters

id
string<uuid>
required

The rule's id, as returned by create.

Response

The rule.

A rule as stored. status, type and target.type are open enums — rules not created through the API can be of other types or bound to a post — so clients must tolerate values create does not accept.

id
string<uuid>
required

The rule's id.

url
string<uri>
required

Link to the rule in the dashboard editor.

status
enum<string>
required

waiting_for_post (waiting for the next post), active, scheduled (window not started), expired (window over), or paused (paused, or stopped after a missed batch send). Derived from the schedule at read time. Filter the list with these same values.

Available options:
waiting_for_post,
active,
scheduled,
expired,
paused
type
string
required

standard for API-created rules; other values can appear.

target
object
required

What the rule applies to.

keywords
string[]
required

Keywords that trigger the rule: a comment triggers it when it contains any of them (case-insensitive). Empty means every comment triggers it.

commentReply
object
required

The public reply posted under a matching comment.

greeting
object
required

The first DM, a message with one tap-to-continue button.

dm
object
required

The main DM the commenter receives.

createdAt
string<date-time>
required

When the rule was created (RFC 3339, UTC).

updatedAt
string<date-time>
required

When the rule was last modified (RFC 3339, UTC). It also moves when the rule's counters change, so it is not an "edited by you" marker.

schedule
object | null

When the rule runs: an operating window (startAt / endAt) or a single batch send (batchSendAt). null means always on.

locale
string | null

Language of DocuRise's default wording (en or ko), or null when none is stored.

restricted
boolean

Instagram is currently restricting this rule's DM delivery.

metrics
object

Lifetime counters for the rule.