curl --request PATCH \
--url https://docurise.io/api/preview/instagram/rules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"guide",
"link"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"status": "waiting_for_post",
"type": "<string>",
"target": {
"type": "<string>",
"mediaId": "<string>"
},
"keywords": [
"<string>"
],
"commentReply": {
"enabled": true,
"variants": [
"<string>"
]
},
"greeting": {
"enabled": true,
"message": "<string>",
"buttonText": "<string>"
},
"dm": {
"message": "<string>",
"requireFollow": true,
"nonFollowerMessage": "<string>",
"nonFollowerButtonText": "<string>",
"buttons": [
{
"url": "<string>",
"text": ""
}
],
"card": {
"imageUrl": "<string>",
"subtitle": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"schedule": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"batchSendAt": "2023-11-07T05:31:56Z"
},
"locale": "<string>",
"restricted": true,
"metrics": {
"sent": 123,
"clicked": 123,
"read": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}Update an Instagram rule
Edit the next-post DM automation rule, or pause or resume it
curl --request PATCH \
--url https://docurise.io/api/preview/instagram/rules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"guide",
"link"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"status": "waiting_for_post",
"type": "<string>",
"target": {
"type": "<string>",
"mediaId": "<string>"
},
"keywords": [
"<string>"
],
"commentReply": {
"enabled": true,
"variants": [
"<string>"
]
},
"greeting": {
"enabled": true,
"message": "<string>",
"buttonText": "<string>"
},
"dm": {
"message": "<string>",
"requireFollow": true,
"nonFollowerMessage": "<string>",
"nonFollowerButtonText": "<string>",
"buttons": [
{
"url": "<string>",
"text": ""
}
],
"card": {
"imageUrl": "<string>",
"subtitle": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"schedule": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"batchSendAt": "2023-11-07T05:31:56Z"
},
"locale": "<string>",
"restricted": true,
"metrics": {
"sent": 123,
"clicked": 123,
"read": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}Authorizations
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
The rule's id, as returned by create.
Body
Every field is optional, but at least one is required. A section you send
replaces that whole section (and must be complete); omitted sections are
untouched. Limits and rules are those of the create request. status is not
an edit: it must be the only field in the request.
paused pauses the rule; active resumes it, so it waits for the next
post. Send it alone, or the request is 422 STATUS_CHANGE_MUST_BE_ALONE.
active, paused The new schedule, or null to remove it.
Response
The rule after the change. Asking for the status the rule already has is also a 200, with the rule unchanged.
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.
The rule's id.
Link to the rule in the dashboard editor.
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.
waiting_for_post, active, scheduled, expired, paused standard for API-created rules; other values can appear.
What the rule applies to.
Show child attributes
Show child attributes
Keywords that trigger the rule: a comment triggers it when it contains any of them (case-insensitive). Empty means every comment triggers it.
The public reply posted under a matching comment.
Show child attributes
Show child attributes
The first DM, a message with one tap-to-continue button.
Show child attributes
Show child attributes
The main DM the commenter receives.
Show child attributes
Show child attributes
When the rule was created (RFC 3339, UTC).
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.
When the rule runs: an operating window (startAt / endAt) or a single batch send (batchSendAt). null means always on.
Show child attributes
Show child attributes
Language of DocuRise's default wording (en or ko), or null when none is stored.
Instagram is currently restricting this rule's DM delivery.
Lifetime counters for the rule.
Show child attributes
Show child attributes