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.
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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DocuRise Developer Docs","colors":{"primary":"#DA350B","light":"#FF3C00","dark":"#AE2D13"},"logo":"https://mintcdn.com/docu-rise/ClhhLqgPXOXvt7Zz/logo.png?fit=max\u0026auto=format\u0026n=ClhhLqgPXOXvt7Zz\u0026q=85\u0026s=b73379a7630a12945d164a128a6ddb12","favicon":"https://mintcdn.com/docu-rise/uxv1U4cKVTA4xM3l/favicon.png?fit=max\u0026auto=format\u0026n=uxv1U4cKVTA4xM3l\u0026q=85\u0026s=0b88e688751814cb08931184873ba0be","appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://docurise.io/dashboard"}},"footer":{"socials":{}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"ko","href":"ko"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"docu-rise","hasAudioNarration":false,"actualSubdomain":"docu-rise","customDomains":["docurise.io"],"gitSource":{"type":"github","owner":"ireneshlee814","repo":"docurise","deployBranch":"master","contentDirectory":"docs-content","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adf7b89b80f21f061134342","collectionId":"820b1d78-0643-45b9-befb-138aad9e313e","liveDeploymentHistoryId":"6adf7b89b80f21f061134342","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adf7b89b80f21f061134342","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"en","tag":"API Reference","count":27},{"language":"ko","tag":"API Reference","count":27},{"language":"en","tag":"Documents","count":8},{"language":"ko","tag":"문서","count":8},{"language":"en","tag":"Audiences","count":7},{"language":"en","tag":"Guides","count":7},{"language":"ko","tag":"오디언스","count":7},{"language":"ko","tag":"가이드","count":7},{"language":"en","tag":"Instagram","count":4},{"language":"ko","tag":"Instagram","count":4},{"language":"en","tag":"Email","count":3},{"language":"en","tag":"Get Started","count":3},{"language":"ko","tag":"이메일","count":3},{"language":"ko","tag":"시작하기","count":3},{"language":"en","tag":"Contacts","count":2},{"language":"en","tag":"Reference","count":2},{"language":"en","tag":"AI Apps","count":2},{"language":"ko","tag":"연락처","count":2},{"language":"ko","tag":"레퍼런스","count":2},{"language":"ko","tag":"AI 앱","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/get-instagram-rule","slug":"/api-reference/get-instagram-rule","pageMetadata":{"title":"Get an Instagram rule","description":"Read one DM automation rule","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules/{id}","href":"/api-reference/get-instagram-rule"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read one DM automation rule\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an Instagram rule","description":"Read one DM automation rule","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules/{id}","href":"/api-reference/get-instagram-rule"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getInstagramRule","tags":["Instagram"],"summary":"Get an Instagram DM rule","description":"Read one DM automation rule","security":["73806d9f-112e-4c8f-8171-0535181c1033"],"responses":{"200":"42bc3618-6e6c-4c2b-a18d-b25f5b47107e","401":"94e73b56-42e4-42b9-8b1a-a4c452d31433","403":"d7114f5e-98c6-4638-b258-b685b8ff4bd3","404":"080ff4cb-b22f-4031-9c57-068a883a34a4","429":"6f22a33d-2857-499d-8fd9-d30805f30de3","500":"0fd5f7eb-b4fa-4943-be52-ef3b874268f9","503":"b127faf9-8209-4c36-bd83-861916c0e15c"},"method":"get","type":"path","servers":["7304e0b3-d967-42dc-a414-a807932689bf"],"path":"/api/preview/instagram/rules/{id}","baseUrlOptions":["https://docurise.io"],"title":"Get an Instagram DM rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"42f8f290-bad1-4a0a-ad8f-ebd4e43f4a01":{"name":"id","in":"path","required":true,"description":"The rule's id, as returned by create.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The rule's id, as returned by create.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"42bc3618-6e6c-4c2b-a18d-b25f5b47107e":{"description":"The rule.","content":{"application/json":{"schema":{"type":"object","required":["id","url","status","type","target","keywords","commentReply","greeting","dm","createdAt","updatedAt"],"description":"A rule as stored. `status`, `type` and `target.type` are open enums —\nrules not created through the API can be of other types or bound to a post — so clients must tolerate values create does not accept.\n","properties":{"id":{"type":"string","format":"uuid","description":"The rule's id.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","description":"Link to the rule in the dashboard editor.","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"status":{"type":"string","enum":["waiting_for_post","active","scheduled","expired","paused"],"description":"`waiting_for_post` (waiting for the next post), `active`, `scheduled`\n(window not started), `expired` (window over), or `paused` (paused, or\nstopped after a missed batch send). Derived from the schedule at read\ntime. Filter the list with these same values.\n","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"`standard` for API-created rules; other values can appear.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"target":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"`next_post`, or `post` once bound to a post.","isRequired":true,"uniqueKey":"target.type","typeLabel":"string"},"mediaId":{"type":"string","description":"Present when `type` is `post`.","uniqueKey":"target.mediaId","typeLabel":"string"}},"description":"What the rule applies to.","isRequired":true,"uniqueKey":"target","typeLabel":"object"},"keywords":{"type":"array","items":{"type":"string","uniqueKey":"keywords.items.[INDEX]","typeLabel":"string"},"description":"Keywords that trigger the rule: a comment triggers it when it contains any of them (case-insensitive). Empty means every comment triggers it.","isRequired":true,"uniqueKey":"keywords","typeLabel":"string[]"},"commentReply":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether DocuRise replies publicly under a matching comment.","uniqueKey":"commentReply.enabled","typeLabel":"boolean"},"variants":{"type":"array","items":{"type":"string","uniqueKey":"commentReply.variants.items.[INDEX]","typeLabel":"string"},"description":"The reply texts; one is picked at random per comment.","uniqueKey":"commentReply.variants","typeLabel":"string[]"}},"description":"The public reply posted under a matching comment.","isRequired":true,"uniqueKey":"commentReply","typeLabel":"object"},"greeting":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the greeting DM is sent first. When `false`, the main DM is sent directly as a private reply.","uniqueKey":"greeting.enabled","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"Text of the greeting DM, or `null` (or an empty string) when the default wording is used.","uniqueKey":"greeting.message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text of the greeting DM, or `null` (or an empty string) when the default wording is used.","uniqueKey":"greeting.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting.message","typeLabel":"string | null"},"buttonText":{"oneOf":[{"type":"string","description":"Label of the tap-to-continue button, or `null` (or an empty string) when the default wording is used.","uniqueKey":"greeting.buttonText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label of the tap-to-continue button, or `null` (or an empty string) when the default wording is used.","uniqueKey":"greeting.buttonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting.buttonText","typeLabel":"string | null"}},"description":"The first DM, a message with one tap-to-continue button.","isRequired":true,"uniqueKey":"greeting","typeLabel":"object"},"dm":{"type":"object","properties":{"message":{"type":"string","description":"Text of the main DM.","uniqueKey":"dm.message","typeLabel":"string"},"requireFollow":{"type":"boolean","description":"Whether `message` goes only to commenters who follow the account; everyone else gets `nonFollowerMessage`.","uniqueKey":"dm.requireFollow","typeLabel":"boolean"},"nonFollowerMessage":{"oneOf":[{"type":"string","description":"DM sent to commenters who do not follow the account, or `null` when none is set.","uniqueKey":"dm.nonFollowerMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"DM sent to commenters who do not follow the account, or `null` when none is set.","uniqueKey":"dm.nonFollowerMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"dm.nonFollowerMessage","typeLabel":"string | null"},"nonFollowerButtonText":{"oneOf":[{"type":"string","description":"Label of the button non-followers tap once they have followed, or `null` when the default label is used or `requireFollow` is `false`.","uniqueKey":"dm.nonFollowerButtonText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label of the button non-followers tap once they have followed, or `null` when the default label is used or `requireFollow` is `false`.","uniqueKey":"dm.nonFollowerButtonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"dm.nonFollowerButtonText","typeLabel":"string | null"},"buttons":{"type":"array","items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","maxLength":2048,"description":"https link. A bare host (`example.com`) is upgraded to `https://`; `http://` and other schemes are rejected.\nTo link one of your DocuRise documents, use its share `url` (the one returned when you create a\ndocument): link-click analytics recognize it as a document button.\n","isRequired":true,"uniqueKey":"dm.buttons.items.[INDEX].url","typeLabel":"string"},"text":{"type":"string","maxLength":20,"default":"","description":"Button label.","uniqueKey":"dm.buttons.items.[INDEX].text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"dm.buttons.items.[INDEX]","typeLabel":"object"},"description":"Link buttons shown under the DM. Empty when there are none.","uniqueKey":"dm.buttons","typeLabel":"object[]"},"card":{"oneOf":[{"type":"object","properties":{"imageUrl":{"oneOf":[{"type":"string","description":"The card's image (an https URL), or `null` when there is none.","uniqueKey":"dm.card.oneOf.0.imageUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The card's image (an https URL), or `null` when there is none.","uniqueKey":"dm.card.oneOf.0.imageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"dm.card.oneOf.0.imageUrl","typeLabel":"string | null"},"subtitle":{"oneOf":[{"type":"string","description":"The card's subtitle, or `null` when there is none.","uniqueKey":"dm.card.oneOf.0.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"The card's subtitle, or `null` when there is none.","uniqueKey":"dm.card.oneOf.0.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"dm.card.oneOf.0.subtitle","typeLabel":"string | null"}},"description":"The rich card (image and/or subtitle) the DM is sent as, or `null` for a plain DM.","uniqueKey":"dm.card.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"imageUrl":{"oneOf":[{"type":"string","description":"The card's image (an https URL), or `null` when there is none."},{"type":"null","description":"The card's image (an https URL), or `null` when there is none."}]},"subtitle":{"oneOf":[{"type":"string","description":"The card's subtitle, or `null` when there is none."},{"type":"null","description":"The card's subtitle, or `null` when there is none."}]}},"description":"The rich card (image and/or subtitle) the DM is sent as, or `null` for a plain DM.","uniqueKey":"dm.card.oneOf.1","typeLabel":"null"}],"uniqueKey":"dm.card","typeLabel":"object | null"}},"description":"The main DM the commenter receives.","isRequired":true,"uniqueKey":"dm","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the rule was created (RFC 3339, UTC).","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"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.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"schedule":{"oneOf":[{"type":"object","properties":{"startAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the operating window starts (RFC 3339, UTC), or `null`.","uniqueKey":"schedule.oneOf.0.startAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the operating window starts (RFC 3339, UTC), or `null`.","uniqueKey":"schedule.oneOf.0.startAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.startAt","typeLabel":"string\u003cdate-time> | null"},"endAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the operating window ends (RFC 3339, UTC), or `null`.","uniqueKey":"schedule.oneOf.0.endAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the operating window ends (RFC 3339, UTC), or `null`.","uniqueKey":"schedule.oneOf.0.endAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.endAt","typeLabel":"string\u003cdate-time> | null"},"batchSendAt":{"oneOf":[{"type":"string","format":"date-time","description":"The moment every matching commenter is sent a DM at once (RFC 3339, UTC), or `null` when the rule is not a batch rule.","uniqueKey":"schedule.oneOf.0.batchSendAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The moment every matching commenter is sent a DM at once (RFC 3339, UTC), or `null` when the rule is not a batch rule.","uniqueKey":"schedule.oneOf.0.batchSendAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.oneOf.0.batchSendAt","typeLabel":"string\u003cdate-time> | null"}},"description":"When the rule runs: an operating window (`startAt` / `endAt`) or a single batch send (`batchSendAt`). `null` means always on.","uniqueKey":"schedule.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"startAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the operating window starts (RFC 3339, UTC), or `null`."},{"type":"null","format":"date-time","description":"When the operating window starts (RFC 3339, UTC), or `null`."}]},"endAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the operating window ends (RFC 3339, UTC), or `null`."},{"type":"null","format":"date-time","description":"When the operating window ends (RFC 3339, UTC), or `null`."}]},"batchSendAt":{"oneOf":[{"type":"string","format":"date-time","description":"The moment every matching commenter is sent a DM at once (RFC 3339, UTC), or `null` when the rule is not a batch rule."},{"type":"null","format":"date-time","description":"The moment every matching commenter is sent a DM at once (RFC 3339, UTC), or `null` when the rule is not a batch rule."}]}},"description":"When the rule runs: an operating window (`startAt` / `endAt`) or a single batch send (`batchSendAt`). `null` means always on.","uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"object | null"},"locale":{"oneOf":[{"type":"string","description":"Language of DocuRise's default wording (`en` or `ko`), or `null` when none is stored.","uniqueKey":"locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"Language of DocuRise's default wording (`en` or `ko`), or `null` when none is stored.","uniqueKey":"locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"locale","typeLabel":"string | null"},"restricted":{"type":"boolean","description":"Instagram is currently restricting this rule's DM delivery.","uniqueKey":"restricted","typeLabel":"boolean"},"metrics":{"type":"object","properties":{"sent":{"type":"integer","description":"People the rule has started a DM conversation with: counted once per commenter, when the first DM (the greeting, or the main DM if the greeting is off) is sent.","uniqueKey":"metrics.sent","typeLabel":"integer"},"clicked":{"type":"integer","description":"Taps on the DM's link buttons (every tap counts, not unique people). The tap-to-continue and non-follower buttons are not included.","uniqueKey":"metrics.clicked","typeLabel":"integer"},"read":{"type":"integer","description":"Recipients who have read a DM from the rule (about one per person; repeat reads within 24 hours are not counted again).","uniqueKey":"metrics.read","typeLabel":"integer"}},"description":"Lifetime counters for the rule.","uniqueKey":"metrics","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90","url":"https://docurise.io/dashboard/instagram/rules/7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90","status":"waiting_for_post","type":"standard","target":{"type":"next_post"},"keywords":["guide","link"],"commentReply":{"enabled":true,"variants":["Sent you a DM!"]},"greeting":{"enabled":true,"message":"Tap below to get the guide","buttonText":"Send it"},"dm":{"message":"Here is the guide 👇","requireFollow":true,"nonFollowerMessage":"Follow us first, then tap again","nonFollowerButtonText":"I followed","buttons":[{"text":"Open guide","url":"https://docurise.io/v/my-guide"}],"card":null},"schedule":{"startAt":"2026-10-01T00:00:00.000Z","endAt":"2026-10-31T23:59:59.000Z","batchSendAt":null},"locale":"en","restricted":false,"metrics":{"sent":0,"clicked":0,"read":0},"createdAt":"2026-09-30T12:00:00.000Z","updatedAt":"2026-09-30T12:00:00.000Z"},"examples":{"Example":{"title":"Example","value":{"id":"7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90","url":"https://docurise.io/dashboard/instagram/rules/7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90","status":"waiting_for_post","type":"standard","target":{"type":"next_post"},"keywords":["guide","link"],"commentReply":{"enabled":true,"variants":["Sent you a DM!"]},"greeting":{"enabled":true,"message":"Tap below to get the guide","buttonText":"Send it"},"dm":{"message":"Here is the guide 👇","requireFollow":true,"nonFollowerMessage":"Follow us first, then tap again","nonFollowerButtonText":"I followed","buttons":[{"text":"Open guide","url":"https://docurise.io/v/my-guide"}],"card":null},"schedule":{"startAt":"2026-10-01T00:00:00.000Z","endAt":"2026-10-31T23:59:59.000Z","batchSendAt":null},"locale":"en","restricted":false,"metrics":{"sent":0,"clicked":0,"read":0},"createdAt":"2026-09-30T12:00:00.000Z","updatedAt":"2026-09-30T12:00:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"94e73b56-42e4-42b9-8b1a-a4c452d31433":{"description":"Missing, malformed, or revoked API key (`code: UNAUTHORIZED`).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"d7114f5e-98c6-4638-b258-b685b8ff4bd3":{"description":"`PLAN_REQUIRED`, `PAST_DUE_RESTRICTED` or `INSUFFICIENT_SCOPE` (the key lacks `instagram:read`).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"080ff4cb-b22f-4031-9c57-068a883a34a4":{"description":"`RULE_NOT_FOUND` — no such rule for this account (unknown, malformed or\nforeign id, or a disconnected Instagram account's rule). Or `NOT_FOUND`\nif the API is not available to the account.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"6f22a33d-2857-499d-8fd9-d30805f30de3":{"description":"Rate limited (`code: RATE_LIMITED`, always retryable): see the `Retry-After` header and `X-RateLimit-*` headers. Or too many requests running at once (`code: TOO_MANY_CONCURRENT_REQUESTS`, always retryable): `Retry-After` is `1` and there are no `X-RateLimit-*` headers.","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-RateLimit-Limit":{"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp (seconds) when the limit resets."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0fd5f7eb-b4fa-4943-be52-ef3b874268f9":{"description":"`INTERNAL_ERROR`: unexpected failure. Retryable; the cause is not returned.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"b127faf9-8209-4c36-bd83-861916c0e15c":{"description":"A server-side dependency is temporarily down (`RATE_LIMIT_UNAVAILABLE`\nor `SERVICE_UNAVAILABLE`). Not a problem with the request or key;\nalways retryable — honor `retryAfterSeconds` when present. The group\nendpoints (`POST /segments`, `POST /segments/preview`,\n`GET /segments/{id}`) also return it when a very heavy rule could not be\ncounted within about 10 seconds: simplify the rule or retry.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"73806d9f-112e-4c8f-8171-0535181c1033":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"dr_live_\u003ckeyId>_\u003csecret>","description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"7304e0b3-d967-42dc-a414-a807932689bf":{"url":"https://docurise.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"dr_live_\u003ckeyId>_\u003csecret>","description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"docu-rise","siteName":"DocuRise Developer Docs","title":"Get an Instagram rule - DocuRise Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/get-instagram-rule","matchLevel":0},"ko":{"href":"/ko/api-reference/get-instagram-rule","matchLevel":1}}},"lastModified":"2026-10-02T04:22:15.018Z","originalFileLocation":"api-reference/get-instagram-rule.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Read one DM automation rule\">\u003cmeta data-mint-head name=\"application-name\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an Instagram rule - DocuRise Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read one DM automation rule\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docurise.io/docs/api-reference/get-instagram-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docu-rise.mintlify.app/_mintlify/api/og/v2?division=Instagram\u0026amp;title=Get+an+Instagram+rule\u0026amp;description=Read+one+DM+automation+rule\u0026amp;theme=53f5ca0b0069a8a509ebc847\u0026amp;signature=b8f72879772cdd6d1f9737c20576874d7e3cf3dac03fb459d2eb942331fcd90a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get an Instagram rule - DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read one DM automation rule\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docu-rise.mintlify.app/_mintlify/api/og/v2?division=Instagram\u0026amp;title=Get+an+Instagram+rule\u0026amp;description=Read+one+DM+automation+rule\u0026amp;theme=53f5ca0b0069a8a509ebc847\u0026amp;signature=b8f72879772cdd6d1f9737c20576874d7e3cf3dac03fb459d2eb942331fcd90a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#DA350B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docurise.io/docs/api-reference/get-instagram-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/get-instagram-rule.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docurise.io/docs/api-reference/get-instagram-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docurise.io/docs/ko/api-reference/get-instagram-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docurise.io/docs/api-reference/get-instagram-rule\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docurise.io/#organization\",\"name\":\"DocuRise Developer Docs\",\"url\":\"https://docurise.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/docu-rise/ClhhLqgPXOXvt7Zz/logo.png?fit=max\u0026auto=format\u0026n=ClhhLqgPXOXvt7Zz\u0026q=85\u0026s=b73379a7630a12945d164a128a6ddb12\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docurise.io/docs#website\",\"name\":\"DocuRise Developer Docs\",\"url\":\"https://docurise.io/docs\",\"publisher\":{\"@id\":\"https://docurise.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docurise.io/docs/api-reference/get-instagram-rule#webpage\",\"url\":\"https://docurise.io/docs/api-reference/get-instagram-rule\",\"name\":\"Get an Instagram rule\",\"description\":\"Read one DM automation rule\",\"dateModified\":\"2026-10-02T04:22:15.018Z\",\"isPartOf\":{\"@id\":\"https://docurise.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docurise.io/docs/api-reference/get-instagram-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docurise.io/docs/api-reference/get-instagram-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Instagram\",\"item\":\"https://docurise.io/docs/api-reference/create-instagram-rule\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an Instagram rule\",\"item\":\"https://docurise.io/docs/api-reference/get-instagram-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docurise.io/docs/api-reference/get-instagram-rule#apireference\",\"headline\":\"Get an Instagram rule\",\"name\":\"Get an Instagram rule\",\"description\":\"Read one DM automation rule\",\"url\":\"https://docurise.io/docs/api-reference/get-instagram-rule\",\"mainEntityOfPage\":{\"@id\":\"https://docurise.io/docs/api-reference/get-instagram-rule#webpage\"},\"dateModified\":\"2026-10-02T04:22:15.018Z\",\"publisher\":{\"@id\":\"https://docurise.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docurise.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DocuRise Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DocuRise Developer Docs","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Documents","pages":[{"title":"Create a document","openapi":"api-reference/openapi.yaml POST /api/preview/documents","href":"/api-reference/create-document"},{"title":"List documents","openapi":"api-reference/openapi.yaml GET /api/preview/documents","href":"/api-reference/list-documents"},{"title":"Get a document","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}","href":"/api-reference/get-document"},{"title":"Update a document","openapi":"api-reference/openapi.yaml PATCH /api/preview/documents/{id}","href":"/api-reference/update-document"},{"title":"Get document analytics","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics","href":"/api-reference/get-document-analytics"},{"title":"Get document analytics by channel","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics/channels","href":"/api-reference/get-document-analytics-channels"},{"title":"Get form funnel","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics/funnel","href":"/api-reference/get-form-funnel"},{"title":"List top documents","openapi":"api-reference/openapi.yaml GET /api/preview/analytics/documents","href":"/api-reference/list-top-documents"}]},{"group":"Folders","pages":[{"title":"List folders and courses","openapi":"api-reference/openapi.yaml GET /api/preview/folders","href":"/api-reference/list-folders"}]},{"group":"Products","pages":[{"title":"List products","openapi":"api-reference/openapi.yaml GET /api/preview/products","href":"/api-reference/list-products"}]},{"group":"Audiences","pages":[{"title":"List tags","openapi":"api-reference/openapi.yaml GET /api/preview/tags","href":"/api-reference/list-tags"},{"title":"Create a tag","openapi":"api-reference/openapi.yaml POST /api/preview/tags","href":"/api-reference/create-tag"},{"title":"List groups","openapi":"api-reference/openapi.yaml GET /api/preview/segments","href":"/api-reference/list-segments"},{"title":"Create a group","openapi":"api-reference/openapi.yaml POST /api/preview/segments","href":"/api-reference/create-segment"},{"title":"Preview a group rule","openapi":"api-reference/openapi.yaml POST /api/preview/segments/preview","href":"/api-reference/preview-segment"},{"title":"Get a group","openapi":"api-reference/openapi.yaml GET /api/preview/segments/{id}","href":"/api-reference/get-segment"},{"title":"Group conditions","href":"/api-reference/group-conditions"}]},{"group":"Contacts","pages":[{"title":"Add a tag to a contact","openapi":"api-reference/openapi.yaml PUT /api/preview/contacts/{contactId}/tags/{tagName}","href":"/api-reference/add-contact-tag"},{"title":"Remove a tag from a contact","openapi":"api-reference/openapi.yaml DELETE /api/preview/contacts/{contactId}/tags/{tagName}","href":"/api-reference/remove-contact-tag"}]},{"group":"Email","pages":[{"title":"List email broadcasts","openapi":"api-reference/openapi.yaml GET /api/preview/email/broadcasts","href":"/api-reference/list-email-broadcasts"},{"title":"Get broadcast insights","openapi":"api-reference/openapi.yaml GET /api/preview/email/broadcasts/{id}/insights","href":"/api-reference/get-broadcast-insights"},{"title":"List automations","openapi":"api-reference/openapi.yaml GET /api/preview/automations","href":"/api-reference/list-automations"}]},{"group":"Instagram","pages":[{"title":"Create an Instagram rule","openapi":"api-reference/openapi.yaml POST /api/preview/instagram/rules","href":"/api-reference/create-instagram-rule"},{"title":"List Instagram rules","description":"List the DM automation rules on your connected Instagram account","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules","href":"/api-reference/list-instagram-rules"},{"title":"Get an Instagram rule","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules/{id}","href":"/api-reference/get-instagram-rule"},{"title":"Update an Instagram rule","description":"Edit the next-post DM automation rule, or pause or resume it","openapi":"api-reference/openapi.yaml PATCH /api/preview/instagram/rules/{id}","href":"/api-reference/update-instagram-rule"}]},{"group":"Account","pages":[{"title":"Inspect the calling key","openapi":"api-reference/openapi.yaml GET /api/preview/whoami","href":"/api-reference/whoami"}]}]}]},{"language":"ko","pages":[{"title":"ko","href":"/ko/api-reference/get-instagram-rule"}]}]},"title":"Get an Instagram rule - DocuRise Developer Docs","buildId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","deploymentId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DsGgv5pK.js","utils-B0h6ZXi-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-IgrnFwPw.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C49-TBER.js","snippetPresets-BPHn-9OB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CGBwAHwX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BjABHCCH.js","shallow-C0Uj5sOI.js","getApiPlaygroundDisplay-BnYiIeY4.js","CodeSnippet-BJWWrlBw.js","CodeSnippets-bxE5aDye.js","Page-BBU7roUf.js","getPastedJson-BAjriezQ.js","icon-BqcS52QC.js","MethodPill-BPGyN9me.js","DuplicateIcon-CCf2giLL.js","createIcon-CVH8aNt2.js","DynamicMarkdown-BklwmxA6.js","SectionHeading-DYCZQFxh.js","axios-vUo_bRtp.js","Markdown-D26rHnOC.js","clsx-DkiOUx4h.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DI8jfVGc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DwJy-csb.js"]}