This API is deprecated, use v2 API instead. Update in-app notification’s action status by its unique key identifier messageId and type field type.
type field can be primary or secondary
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Novu","description":"The open-source notification infrastructure for agents and products. Send, receive, and track notifications across channels.","colors":{"primary":"#0e121b","light":"#FFFFFF","dark":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4","dark":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/dark.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=bd7c54f6b7a7b5002ea7b525af3e169c","href":"https://docs.novu.co"},"favicon":"https://mintcdn.com/novu-c5de82d9/ZUl3xXp-4AASlrcI/favicon.svg?fit=max\u0026auto=format\u0026n=ZUl3xXp-4AASlrcI\u0026q=85\u0026s=b53c3afb6a8eaf11aff9db2c5d3f05a1","api":{"openapi":"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples","examples":{"prefill":true}},"background":{},"navbar":{"links":[{"href":"https://novu.co/contact-us","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://dashboard.novu.co/auth/sign-up"}},"footer":{"socials":{"x":"https://x.com/novuhq","github":"https://github.com/novuhq/novu","linkedin":"https://www.linkedin.com/company/novuco"},"links":[{"header":"Comparison","items":[{"label":"Novu vs Courier","href":"https://novu.co/comparison/courier"},{"label":"Novu vs Knock","href":"https://novu.co/comparison/knock"},{"label":"Novu vs MagicBell","href":"https://novu.co/comparison/magicbell"},{"label":"Novu vs SuprSend","href":"https://novu.co/comparison/suprsend"},{"label":"Novu vs In-house","href":"https://novu.co/comparison/building-in-house"}]},{"header":"Resources","items":[{"label":"Contact Support","href":"mailto:support@novu.co"},{"label":"Changelog","href":"https://go.novu.co/changelog?utm_source=docs_footer"},{"label":"Roadmap","href":"https://roadmap.novu.co/roadmap"},{"label":"Contact Sales","href":"https://novu.co/contact-us"},{"label":"Read llms.txt","href":"/llms.txt"}]}]},"seo":{"metatags":{"og:type":"website","twitter:card":"summary_large_image"},"indexing":"all"},"icons":{"library":"lucide"},"integrations":{"gtm":{"tagId":"GTM-KXMC4XP2"},"plausible":{"domain":"docs.novu.co"}},"contextual":{"options":["copy","view","cursor","claude","chatgpt","mcp","add-mcp"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/novu-c5de82d9/vncv7ET97M5-dM6d/images/og/og-image-docs-v2.jpg?fit=max\u0026auto=format\u0026n=vncv7ET97M5-dM6d\u0026q=85\u0026s=26b59f5c597b5b1bea44cbc57cad5e3a","fonts":{"family":"Inter"}},"interaction":{"drilldown":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"novu-c5de82d9","hasAudioNarration":false,"actualSubdomain":"novu-c5de82d9","customDomains":["docs.novu.co"],"gitSource":{"type":"github","owner":"novuhq","repo":"novu","deployBranch":"next","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"313ea6a7-dc00-4182-b4a8-2d4cea7d9086","liveDeploymentHistoryId":"6ae2023c201cdb70a5227b24","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2023c201cdb70a5227b24"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6ae2023c201cdb70a5227b24","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Notify","count":217},{"language":"default","tag":"API Reference","count":160},{"language":"default","tag":"Resources","count":107},{"language":"default","tag":"Integrate Channels Providers","count":93},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Data","count":63},{"language":"default","tag":"Getting Started","count":62},{"language":"default","tag":"Framework","count":52},{"language":"default","tag":"Agent Connect","count":41},{"language":"default","tag":"Sms","count":38}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@novu.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){#sidebar-content{width:16rem;min-width:16rem;max-width:16rem}}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{background:0 0!important;color:rgb(75 85 99)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{color:rgb(156 163 175)}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(3 7 18/.03)!important;color:rgb(17 24 39)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(255 255 255/.03)!important;color:rgb(229 231 235)}#home-content .hero-cards{margin-top:1.5rem}#home-content .card [data-component-part=card-image]{width:107.5%;max-width:none;margin:-3.75% -3.75% 0}"}],"page":{"pagePath":"api-reference/subscribers/update-notification-action-status","slug":"/api-reference/subscribers/update-notification-action-status","pageMetadata":{"title":"Update notification action status","openapi":"POST /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","description":"This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier **messageId** and type field **type**. \n **type** field can be **primary** or **secondary**","href":"/api-reference/subscribers/update-notification-action-status"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"This API is deprecated, use v2 API instead. Update in-app notification’s action status by its unique key identifier \", _jsx(_components.strong, {\n children: \"messageId\"\n }), \" and type field \", _jsx(_components.strong, {\n children: \"type\"\n }), \".\\n\", _jsx(_components.strong, {\n children: \"type\"\n }), \" field can be \", _jsx(_components.strong, {\n children: \"primary\"\n }), \" or \", _jsx(_components.strong, {\n children: \"secondary\"\n })]\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":"Update notification action status","openapi":"POST /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","description":"This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier **messageId** and type field **type**. \n **type** field can be **primary** or **secondary**","href":"/api-reference/subscribers/update-notification-action-status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"SubscribersV1Controller_markActionAsSeen","x-speakeasy-name-override":"updateAsSeen","x-speakeasy-group":"Subscribers.Messages","summary":"Update notification action status","description":"This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier **messageId** and type field **type**. \n **type** field can be **primary** or **secondary**","deprecated":true,"parameters":["5465fb7c-6584-4f60-b1d8-b53909e0a256","c70b96ad-953c-41fd-bae1-51756fc7251b","1e3c5649-665a-429e-a61a-f7390c40a3fd","548027ff-e430-4a7b-90a3-65fffa4eacc3"],"requestBody":"58526d74-f5eb-49a5-a1af-32c61e02b679","responses":{"201":"4fd0dd9b-f7dc-43a1-94bd-787d51e7024f","400":"93d35f47-de60-4715-a828-70a26dafa1c2","401":"5846473b-89f5-4213-b1f4-101a7e2b8f80","403":"4418c58d-6c54-41cb-9ac0-e748bab81360","404":"6b012b19-c088-47b8-892a-b063b05ff970","405":"50a344f2-a6e1-46b2-884a-36ddca7b0231","409":"58ff2b81-1643-4eae-a76f-06ac770ab5e6","413":"b5fad3af-3a18-4e86-99a3-b5d3c591533d","414":"3450463a-bf12-47b9-b307-35eeccb88fbe","415":"e2e8387c-df16-4da3-931d-232fbf058f73","422":"898e7aba-8d31-489f-8656-6291dc77b6cc","429":"5356046e-0b21-4fb1-a0fb-877c919424bf","500":"2e6803dd-9066-41b2-b575-35f807e645ff","503":"7668042c-b2fb-4ed2-8f41-f42705ef2f8c"},"tags":["Subscribers"],"security":["3ba3a254-a44a-4ac0-bd26-1035042db7a2"],"method":"post","type":"path","servers":["29cc13d7-64c7-40f9-8a35-9c01537b78f4","7588375a-aa7e-462d-a5bf-d94b8564f985"],"path":"/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","baseUrlOptions":["https://api.novu.co","https://eu.api.novu.co"],"title":"Update notification action status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.payload":{}}]},"dependencies":{"parameters":{"5465fb7c-6584-4f60-b1d8-b53909e0a256":{"name":"messageId","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"c70b96ad-953c-41fd-bae1-51756fc7251b":{"name":"type","required":true,"in":"path","schema":{}},"1e3c5649-665a-429e-a61a-f7390c40a3fd":{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"548027ff-e430-4a7b-90a3-65fffa4eacc3":{"name":"idempotency-key","in":"header","description":"A header for idempotency purposes","required":false,"schema":{"type":"string","isRequired":false,"description":"A header for idempotency purposes","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["pending","done"],"type":"string","description":"Message action status","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Message action payload","uniqueKey":"payload","typeLabel":"object"}},"required":["status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4fd0dd9b-f7dc-43a1-94bd-787d51e7024f":{"description":"Created","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"_environmentId":{"type":"string","description":"Environment ID where the message is sent","isRequired":true,"uniqueKey":"_environmentId","typeLabel":"string"},"_organizationId":{"type":"string","description":"Organization ID associated with the message","isRequired":true,"uniqueKey":"_organizationId","typeLabel":"string"},"_notificationId":{"type":"string","description":"Notification ID associated with the message","isRequired":true,"uniqueKey":"_notificationId","typeLabel":"string"},"_subscriberId":{"type":"string","description":"Subscriber ID associated with the message","isRequired":true,"uniqueKey":"_subscriberId","typeLabel":"string"},"createdAt":{"type":"string","description":"Creation date of the message","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"transactionId":{"type":"string","description":"Transaction ID associated with the message","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string"},"channel":{"type":"string","description":"Channel type through which the message is sent","enum":["in_app","email","sms","chat","push","tool"],"isRequired":true,"uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"read":{"type":"boolean","description":"Indicates if the message has been read","isRequired":true,"uniqueKey":"read","typeLabel":"boolean"},"seen":{"type":"boolean","description":"Indicates if the message has been seen","isRequired":true,"uniqueKey":"seen","typeLabel":"boolean"},"cta":{"type":"object","description":"Call to action associated with the message","properties":{"type":{"type":"string","description":"Type of call to action","enum":["redirect"],"uniqueKey":"cta.type","typeLabel":"enum\u003cstring>"},"data":{"type":"object","description":"Data associated with the call to action","properties":{"url":{"type":"string","description":"URL for the call to action","uniqueKey":"cta.data.url","typeLabel":"string"}},"uniqueKey":"cta.data","typeLabel":"object"},"action":{"type":"object","description":"Action associated with the call to action","properties":{"status":{"type":"string","description":"Status of the message action","enum":["pending","done"],"uniqueKey":"cta.action.status","typeLabel":"enum\u003cstring>"},"buttons":{"description":"List of buttons associated with the message action","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of button for the action result","enum":["primary","secondary"],"isRequired":true,"uniqueKey":"cta.action.buttons.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"content":{"type":"string","description":"Content of the button","isRequired":true,"uniqueKey":"cta.action.buttons.items.[INDEX].content","typeLabel":"string"},"resultContent":{"type":"string","description":"Content of the result when the button is clicked","uniqueKey":"cta.action.buttons.items.[INDEX].resultContent","typeLabel":"string"}},"required":["type","content"],"uniqueKey":"cta.action.buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cta.action.buttons","typeLabel":"object[]"},"result":{"type":"object","description":"Result of the message action","properties":{"payload":{"type":"object","description":"Payload of the action result","additionalProperties":true,"uniqueKey":"cta.action.result.payload","typeLabel":"object"},"type":{"type":"string","description":"Type of button for the action result","enum":["primary","secondary"],"uniqueKey":"cta.action.result.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cta.action.result","typeLabel":"object"}},"uniqueKey":"cta.action","typeLabel":"object"}},"isRequired":true,"uniqueKey":"cta","typeLabel":"object"},"status":{"type":"string","description":"Status of the message","enum":["sent","error","warning"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"_id":{"type":"string","description":"Unique identifier for the message","uniqueKey":"_id","typeLabel":"string"},"_templateId":{"oneOf":[{"type":"string","description":"Template ID associated with the message","uniqueKey":"_templateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Template ID associated with the message","uniqueKey":"_templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"_templateId","typeLabel":"string | null"},"_messageTemplateId":{"oneOf":[{"type":"string","description":"Message template ID","uniqueKey":"_messageTemplateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message template ID","uniqueKey":"_messageTemplateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"_messageTemplateId","typeLabel":"string | null"},"subscriber":{"type":"object","description":"Subscriber details, if available","required":["subscriberId","_organizationId","_environmentId","deleted","createdAt","updatedAt"],"properties":{"subscriberId":{"type":"string","description":"The identifier used to create this subscriber, which typically corresponds to the user ID in your system.","isRequired":true,"uniqueKey":"subscriber.subscriberId","typeLabel":"string"},"_organizationId":{"type":"string","description":"The unique identifier of the organization to which the subscriber belongs.","isRequired":true,"uniqueKey":"subscriber._organizationId","typeLabel":"string"},"_environmentId":{"type":"string","description":"The unique identifier of the environment associated with this subscriber.","isRequired":true,"uniqueKey":"subscriber._environmentId","typeLabel":"string"},"deleted":{"type":"boolean","description":"Indicates whether the subscriber has been deleted.","isRequired":true,"uniqueKey":"subscriber.deleted","typeLabel":"boolean"},"createdAt":{"type":"string","description":"The timestamp indicating when the subscriber was created, in ISO 8601 format.","isRequired":true,"uniqueKey":"subscriber.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"The timestamp indicating when the subscriber was last updated, in ISO 8601 format.","isRequired":true,"uniqueKey":"subscriber.updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"The internal ID generated by Novu for your subscriber. This ID does not match the `subscriberId` used in your queries. Refer to `subscriberId` for that identifier.","uniqueKey":"subscriber._id","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"The first name of the subscriber.","uniqueKey":"subscriber.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name of the subscriber.","uniqueKey":"subscriber.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"The last name of the subscriber.","uniqueKey":"subscriber.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name of the subscriber.","uniqueKey":"subscriber.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"The email address of the subscriber.","uniqueKey":"subscriber.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The email address of the subscriber.","uniqueKey":"subscriber.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number of the subscriber.","uniqueKey":"subscriber.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number of the subscriber.","uniqueKey":"subscriber.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.phone","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","description":"The URL of the subscriber's avatar image.","uniqueKey":"subscriber.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL of the subscriber's avatar image.","uniqueKey":"subscriber.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.avatar","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","description":"The locale setting of the subscriber, indicating their preferred language or region.","uniqueKey":"subscriber.locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"The locale setting of the subscriber, indicating their preferred language or region.","uniqueKey":"subscriber.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.locale","typeLabel":"string | null"},"channels":{"description":"An array of channel settings associated with the subscriber.","type":"array","items":{"type":"object","properties":{"providerId":{"type":"string","description":"The provider identifier for the credentials","enum":["slack","discord","msteams","webex-messaging","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","line","chat-webhook","novu-slack","telegram","sendblue","novu-web-chat","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams","appio"],"isRequired":true,"uniqueKey":"subscriber.channels.items.[INDEX].providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials payload for the specified provider","properties":{"webhookUrl":{"type":"string","description":"Webhook URL used by chat app integrations. The webhook should be obtained from the chat app provider.","example":"https://example.com/webhook","uniqueKey":"subscriber.channels.items.[INDEX].credentials.webhookUrl","typeLabel":"string"},"channel":{"type":"string","description":"Channel specification for Mattermost chat notifications.","example":"general","uniqueKey":"subscriber.channels.items.[INDEX].credentials.channel","typeLabel":"string"},"deviceTokens":{"description":"Contains an array of the subscriber device tokens for a given provider. Used on Push integrations.","example":["token1","token2","token3"],"type":"array","items":{"type":"string","uniqueKey":"subscriber.channels.items.[INDEX].credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"subscriber.channels.items.[INDEX].credentials.deviceTokens","typeLabel":"string[]"},"alertUid":{"type":"string","description":"Alert UID for Grafana on-call webhook payload.","example":"12345-abcde","uniqueKey":"subscriber.channels.items.[INDEX].credentials.alertUid","typeLabel":"string"},"title":{"type":"string","description":"Title to be used with Grafana on-call webhook.","example":"Critical Alert","uniqueKey":"subscriber.channels.items.[INDEX].credentials.title","typeLabel":"string"},"imageUrl":{"type":"string","description":"Image URL property for Grafana on-call webhook.","example":"https://example.com/image.png","uniqueKey":"subscriber.channels.items.[INDEX].credentials.imageUrl","typeLabel":"string"},"state":{"type":"string","description":"State property for Grafana on-call webhook.","example":"resolved","uniqueKey":"subscriber.channels.items.[INDEX].credentials.state","typeLabel":"string"},"externalUrl":{"type":"string","description":"Link to upstream details property for Grafana on-call webhook.","example":"https://example.com/details","uniqueKey":"subscriber.channels.items.[INDEX].credentials.externalUrl","typeLabel":"string"}},"isRequired":true,"uniqueKey":"subscriber.channels.items.[INDEX].credentials","typeLabel":"object"},"_integrationId":{"type":"string","description":"The unique identifier of the integration associated with this channel.","isRequired":true,"uniqueKey":"subscriber.channels.items.[INDEX]._integrationId","typeLabel":"string"},"integrationIdentifier":{"type":"string","description":"The integration identifier","uniqueKey":"subscriber.channels.items.[INDEX].integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials","_integrationId"],"uniqueKey":"subscriber.channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subscriber.channels","typeLabel":"object[]"},"topics":{"description":"An array of topics that the subscriber is subscribed to.","deprecated":true,"type":"array","items":{"type":"string","uniqueKey":"subscriber.topics.items.[INDEX]","typeLabel":"string"},"uniqueKey":"subscriber.topics","typeLabel":"string[]"},"isOnline":{"oneOf":[{"type":"boolean","description":"Indicates whether the subscriber is currently online.","uniqueKey":"subscriber.isOnline.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the subscriber is currently online.","uniqueKey":"subscriber.isOnline.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.isOnline","typeLabel":"boolean | null"},"lastOnlineAt":{"oneOf":[{"type":"string","description":"The timestamp indicating when the subscriber was last online, in ISO 8601 format.","uniqueKey":"subscriber.lastOnlineAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp indicating when the subscriber was last online, in ISO 8601 format.","uniqueKey":"subscriber.lastOnlineAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.lastOnlineAt","typeLabel":"string | null"},"__v":{"type":"number","description":"The version of the subscriber document.","uniqueKey":"subscriber.__v","typeLabel":"number"},"data":{"oneOf":[{"type":"object","description":"Additional custom data for the subscriber","additionalProperties":true,"uniqueKey":"subscriber.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional custom data for the subscriber","additionalProperties":true,"uniqueKey":"subscriber.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.data","typeLabel":"object | null"},"timezone":{"oneOf":[{"type":"string","description":"Timezone of the subscriber","uniqueKey":"subscriber.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timezone of the subscriber","uniqueKey":"subscriber.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriber.timezone","typeLabel":"string | null"}},"uniqueKey":"subscriber","typeLabel":"object"},"template":{"type":"object","description":"Workflow template associated with the message","required":["name","description","active","draft","preferenceSettings","critical","tags","steps","_organizationId","_creatorId","_environmentId","triggers","_notificationGroupId","deleted","deletedAt","deletedBy"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"template.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"template.description","typeLabel":"string"},"active":{"type":"boolean","isRequired":true,"uniqueKey":"template.active","typeLabel":"boolean"},"draft":{"type":"boolean","isRequired":true,"uniqueKey":"template.draft","typeLabel":"boolean"},"preferenceSettings":{"type":"object","properties":{"email":{"type":"boolean","description":"Email channel preference","example":true,"uniqueKey":"template.preferenceSettings.email","typeLabel":"boolean"},"sms":{"type":"boolean","description":"SMS channel preference","example":false,"uniqueKey":"template.preferenceSettings.sms","typeLabel":"boolean"},"in_app":{"type":"boolean","description":"In-app channel preference","example":true,"uniqueKey":"template.preferenceSettings.in_app","typeLabel":"boolean"},"chat":{"type":"boolean","description":"Chat channel preference","example":false,"uniqueKey":"template.preferenceSettings.chat","typeLabel":"boolean"},"push":{"type":"boolean","description":"Push notification channel preference","example":true,"uniqueKey":"template.preferenceSettings.push","typeLabel":"boolean"},"tool":{"type":"boolean","description":"Tool channel preference","example":true,"uniqueKey":"template.preferenceSettings.tool","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"template.preferenceSettings","typeLabel":"object"},"critical":{"type":"boolean","isRequired":true,"uniqueKey":"template.critical","typeLabel":"boolean"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"template.tags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"template.tags","typeLabel":"string[]"},"steps":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the notification step.","uniqueKey":"template.steps.items.[INDEX]._id","typeLabel":"string"},"uuid":{"type":"string","description":"Universally unique identifier for the notification step.","uniqueKey":"template.steps.items.[INDEX].uuid","typeLabel":"string"},"name":{"type":"string","description":"Name of the notification step.","uniqueKey":"template.steps.items.[INDEX].name","typeLabel":"string"},"_templateId":{"type":"string","description":"ID of the template associated with this notification step.","uniqueKey":"template.steps.items.[INDEX]._templateId","typeLabel":"string"},"active":{"type":"boolean","description":"Indicates whether the notification step is active.","uniqueKey":"template.steps.items.[INDEX].active","typeLabel":"boolean"},"shouldStopOnFail":{"type":"boolean","description":"Determines if the process should stop on failure.","uniqueKey":"template.steps.items.[INDEX].shouldStopOnFail","typeLabel":"boolean"},"template":{"type":"object","description":"Message template used in this notification step.","properties":{},"uniqueKey":"template.steps.items.[INDEX].template","typeLabel":"object"},"filters":{"description":"Filters applied to this notification step.","type":"array","items":{"type":"object","properties":{"isNegated":{"type":"boolean","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].isNegated","typeLabel":"boolean"},"type":{"type":"string","enum":["BOOLEAN","TEXT","DATE","NUMBER","STATEMENT","LIST","MULTI_LIST","GROUP"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","enum":["AND","OR"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"},"children":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].field","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].value","typeLabel":"string"},"operator":{"type":"string","enum":["LARGER","SMALLER","LARGER_EQUAL","SMALLER_EQUAL","EQUAL","NOT_EQUAL","ALL_IN","ANY_IN","NOT_IN","BETWEEN","NOT_BETWEEN","LIKE","NOT_LIKE","IN"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"on":{"type":"string","enum":["subscriber","payload"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].on","typeLabel":"enum\u003cstring>"}},"required":["field","value","operator","on"],"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX].children","typeLabel":"object[]"}},"required":["isNegated","type","value","children"],"uniqueKey":"template.steps.items.[INDEX].filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"template.steps.items.[INDEX].filters","typeLabel":"object[]"},"_parentId":{"type":"string","description":"ID of the parent notification step, if applicable.","uniqueKey":"template.steps.items.[INDEX]._parentId","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["regular","backoff"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.unit","typeLabel":"enum\u003cstring>"},"digestKey":{"type":"string","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.digestKey","typeLabel":"string"},"backoff":{"type":"boolean","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.backoff","typeLabel":"boolean"},"backoffAmount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.backoffAmount","typeLabel":"number"},"backoffUnit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.backoffUnit","typeLabel":"enum\u003cstring>"},"updateMode":{"type":"boolean","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0.updateMode","typeLabel":"boolean"}},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["timed"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.unit","typeLabel":"enum\u003cstring>"},"digestKey":{"type":"string","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.digestKey","typeLabel":"string"},"timed":{"type":"object","properties":{"atTime":{"type":"string","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.atTime","typeLabel":"string"},"weekDays":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.weekDays.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.weekDays","typeLabel":"enum\u003cstring>[]"},"monthDays":{"type":"array","items":{"type":"string","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.monthDays.items.[INDEX]","typeLabel":"string"},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.monthDays","typeLabel":"string[]"},"ordinal":{"type":"string","enum":["1","2","3","4","5","last"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.ordinal","typeLabel":"enum\u003cstring>"},"ordinalValue":{"type":"string","enum":["day","weekday","weekend","sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.ordinalValue","typeLabel":"enum\u003cstring>"},"monthlyType":{"type":"string","enum":["each","on"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed.monthlyType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1.timed","typeLabel":"object"}},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.1","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["regular"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.2.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.2.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.2.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.2","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type","delayPath"],"properties":{"type":{"type":"string","enum":["scheduled"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.3.type","typeLabel":"enum\u003cstring>"},"delayPath":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.3.delayPath","typeLabel":"string"}},"uniqueKey":"template.steps.items.[INDEX].metadata.oneOf.3","typeLabel":"object"}],"uniqueKey":"template.steps.items.[INDEX].metadata","typeLabel":"object"},"replyCallback":{"type":"object","description":"Callback information for replies, including whether it is active and the callback URL.","properties":{"active":{"type":"boolean","description":"Indicates whether the reply callback is active.","uniqueKey":"template.steps.items.[INDEX].replyCallback.active","typeLabel":"boolean"},"url":{"type":"string","description":"The URL to which replies should be sent.","uniqueKey":"template.steps.items.[INDEX].replyCallback.url","typeLabel":"string"}},"uniqueKey":"template.steps.items.[INDEX].replyCallback","typeLabel":"object"},"variants":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the notification step.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX]._id","typeLabel":"string"},"uuid":{"type":"string","description":"Universally unique identifier for the notification step.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].uuid","typeLabel":"string"},"name":{"type":"string","description":"Name of the notification step.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].name","typeLabel":"string"},"_templateId":{"type":"string","description":"ID of the template associated with this notification step.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX]._templateId","typeLabel":"string"},"active":{"type":"boolean","description":"Indicates whether the notification step is active.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].active","typeLabel":"boolean"},"shouldStopOnFail":{"type":"boolean","description":"Determines if the process should stop on failure.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].shouldStopOnFail","typeLabel":"boolean"},"template":{"type":"object","description":"Message template used in this notification step.","properties":{},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].template","typeLabel":"object"},"filters":{"description":"Filters applied to this notification step.","type":"array","items":{"type":"object","properties":{"isNegated":{"type":"boolean","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].isNegated","typeLabel":"boolean"},"type":{"type":"string","enum":["BOOLEAN","TEXT","DATE","NUMBER","STATEMENT","LIST","MULTI_LIST","GROUP"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","enum":["AND","OR"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"},"children":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].field","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].value","typeLabel":"string"},"operator":{"type":"string","enum":["LARGER","SMALLER","LARGER_EQUAL","SMALLER_EQUAL","EQUAL","NOT_EQUAL","ALL_IN","ANY_IN","NOT_IN","BETWEEN","NOT_BETWEEN","LIKE","NOT_LIKE","IN"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"on":{"type":"string","enum":["subscriber","payload"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children.items.[INDEX].on","typeLabel":"enum\u003cstring>"}},"required":["field","value","operator","on"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX].children","typeLabel":"object[]"}},"required":["isNegated","type","value","children"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].filters","typeLabel":"object[]"},"_parentId":{"type":"string","description":"ID of the parent notification step, if applicable.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX]._parentId","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["regular","backoff"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.unit","typeLabel":"enum\u003cstring>"},"digestKey":{"type":"string","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.digestKey","typeLabel":"string"},"backoff":{"type":"boolean","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.backoff","typeLabel":"boolean"},"backoffAmount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.backoffAmount","typeLabel":"number"},"backoffUnit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.backoffUnit","typeLabel":"enum\u003cstring>"},"updateMode":{"type":"boolean","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0.updateMode","typeLabel":"boolean"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["timed"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.unit","typeLabel":"enum\u003cstring>"},"digestKey":{"type":"string","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.digestKey","typeLabel":"string"},"timed":{"type":"object","properties":{"atTime":{"type":"string","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.atTime","typeLabel":"string"},"weekDays":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.weekDays.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.weekDays","typeLabel":"enum\u003cstring>[]"},"monthDays":{"type":"array","items":{"type":"string","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.monthDays.items.[INDEX]","typeLabel":"string"},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.monthDays","typeLabel":"string[]"},"ordinal":{"type":"string","enum":["1","2","3","4","5","last"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.ordinal","typeLabel":"enum\u003cstring>"},"ordinalValue":{"type":"string","enum":["day","weekday","weekend","sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.ordinalValue","typeLabel":"enum\u003cstring>"},"monthlyType":{"type":"string","enum":["each","on"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed.monthlyType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1.timed","typeLabel":"object"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.1","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type"],"properties":{"type":{"type":"string","enum":["regular"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.2.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.2.amount","typeLabel":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.2.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.2","typeLabel":"object"},{"type":"object","description":"Metadata associated with the workflow step. Can vary based on the type of step.","required":["type","delayPath"],"properties":{"type":{"type":"string","enum":["scheduled"],"isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.3.type","typeLabel":"enum\u003cstring>"},"delayPath":{"type":"string","isRequired":true,"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.3.delayPath","typeLabel":"string"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata.oneOf.3","typeLabel":"object"}],"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].metadata","typeLabel":"object"},"replyCallback":{"type":"object","description":"Callback information for replies, including whether it is active and the callback URL.","properties":{"active":{"type":"boolean","description":"Indicates whether the reply callback is active.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].replyCallback.active","typeLabel":"boolean"},"url":{"type":"string","description":"The URL to which replies should be sent.","uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].replyCallback.url","typeLabel":"string"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX].replyCallback","typeLabel":"object"}},"uniqueKey":"template.steps.items.[INDEX].variants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"template.steps.items.[INDEX].variants","typeLabel":"object[]"}},"uniqueKey":"template.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.steps","typeLabel":"object[]"},"_organizationId":{"type":"string","isRequired":true,"uniqueKey":"template._organizationId","typeLabel":"string"},"_creatorId":{"type":"string","isRequired":true,"uniqueKey":"template._creatorId","typeLabel":"string"},"_environmentId":{"type":"string","isRequired":true,"uniqueKey":"template._environmentId","typeLabel":"string"},"triggers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["event"],"isRequired":true,"uniqueKey":"template.triggers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"identifier":{"type":"string","isRequired":true,"uniqueKey":"template.triggers.items.[INDEX].identifier","typeLabel":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the variable","isRequired":true,"uniqueKey":"template.triggers.items.[INDEX].variables.items.[INDEX].name","typeLabel":"string"}},"required":["name"],"uniqueKey":"template.triggers.items.[INDEX].variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.triggers.items.[INDEX].variables","typeLabel":"object[]"},"subscriberVariables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the variable","isRequired":true,"uniqueKey":"template.triggers.items.[INDEX].subscriberVariables.items.[INDEX].name","typeLabel":"string"}},"required":["name"],"uniqueKey":"template.triggers.items.[INDEX].subscriberVariables.items.[INDEX]","typeLabel":"object"},"uniqueKey":"template.triggers.items.[INDEX].subscriberVariables","typeLabel":"object[]"}},"required":["type","identifier","variables"],"uniqueKey":"template.triggers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.triggers","typeLabel":"object[]"},"_notificationGroupId":{"type":"string","isRequired":true,"uniqueKey":"template._notificationGroupId","typeLabel":"string"},"deleted":{"type":"boolean","isRequired":true,"uniqueKey":"template.deleted","typeLabel":"boolean"},"deletedAt":{"type":"string","isRequired":true,"uniqueKey":"template.deletedAt","typeLabel":"string"},"deletedBy":{"type":"string","isRequired":true,"uniqueKey":"template.deletedBy","typeLabel":"string"},"_id":{"type":"string","uniqueKey":"template._id","typeLabel":"string"},"_parentId":{"type":"string","uniqueKey":"template._parentId","typeLabel":"string"},"notificationGroup":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"template.notificationGroup.name","typeLabel":"string"},"_environmentId":{"type":"string","isRequired":true,"uniqueKey":"template.notificationGroup._environmentId","typeLabel":"string"},"_organizationId":{"type":"string","isRequired":true,"uniqueKey":"template.notificationGroup._organizationId","typeLabel":"string"},"_id":{"type":"string","uniqueKey":"template.notificationGroup._id","typeLabel":"string"},"_parentId":{"type":"string","uniqueKey":"template.notificationGroup._parentId","typeLabel":"string"}},"required":["name","_environmentId","_organizationId"],"uniqueKey":"template.notificationGroup","typeLabel":"object"},"data":{"type":"object","uniqueKey":"template.data","typeLabel":"object"},"workflowIntegrationStatus":{"type":"object","uniqueKey":"template.workflowIntegrationStatus","typeLabel":"object"}},"uniqueKey":"template","typeLabel":"object"},"templateIdentifier":{"type":"string","description":"Identifier for the message template","uniqueKey":"templateIdentifier","typeLabel":"string"},"deliveredAt":{"description":"Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed","type":"array","items":{"type":"string","uniqueKey":"deliveredAt.items.[INDEX]","typeLabel":"string"},"uniqueKey":"deliveredAt","typeLabel":"string[]"},"lastSeenDate":{"type":"string","description":"Last seen date of the message, if available","uniqueKey":"lastSeenDate","typeLabel":"string"},"lastReadDate":{"type":"string","description":"Last read date of the message, if available","uniqueKey":"lastReadDate","typeLabel":"string"},"content":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the email block","enum":["button","text"],"isRequired":true,"uniqueKey":"content.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"content":{"type":"string","description":"Content of the email block","isRequired":true,"uniqueKey":"content.oneOf.0.items.[INDEX].content","typeLabel":"string"},"url":{"type":"string","description":"URL associated with the email block, if any","uniqueKey":"content.oneOf.0.items.[INDEX].url","typeLabel":"string"},"styles":{"type":"object","description":"Styles applied to the email block","required":["textAlign"],"properties":{"textAlign":{"type":"string","description":"Text alignment for the email block","enum":["center","left","right"],"isRequired":true,"uniqueKey":"content.oneOf.0.items.[INDEX].styles.textAlign","typeLabel":"enum\u003cstring>"}},"uniqueKey":"content.oneOf.0.items.[INDEX].styles","typeLabel":"object"}},"required":["type","content"],"uniqueKey":"content.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Content of the message, can be an email block or a string","uniqueKey":"content.oneOf.0","typeLabel":"object[]"},{"type":"string","description":"Content of the message, can be an email block or a string","uniqueKey":"content.oneOf.1","typeLabel":"string"},{"type":"null","uniqueKey":"content.oneOf.2","typeLabel":"null"}],"uniqueKey":"content","typeLabel":"object[] | string | null"},"subject":{"type":"string","description":"Subject of the message, if applicable","uniqueKey":"subject","typeLabel":"string"},"snoozedUntil":{"type":"string","description":"Date when the message will be unsnoozed","uniqueKey":"snoozedUntil","typeLabel":"string"},"email":{"type":"string","description":"Email address associated with the message, if applicable","uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","description":"Phone number associated with the message, if applicable","uniqueKey":"phone","typeLabel":"string"},"directWebhookUrl":{"type":"string","description":"Direct webhook URL for the message, if applicable","uniqueKey":"directWebhookUrl","typeLabel":"string"},"providerId":{"type":"string","description":"Provider ID associated with the message, if applicable","uniqueKey":"providerId","typeLabel":"string"},"deviceTokens":{"description":"Device tokens associated with the message, if applicable","type":"array","items":{"type":"string","uniqueKey":"deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"deviceTokens","typeLabel":"string[]"},"title":{"type":"string","description":"Title of the message, if applicable","uniqueKey":"title","typeLabel":"string"},"_feedId":{"oneOf":[{"type":"string","description":"Feed ID associated with the message, if applicable","uniqueKey":"_feedId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Feed ID associated with the message, if applicable","uniqueKey":"_feedId.oneOf.1","typeLabel":"null"}],"uniqueKey":"_feedId","typeLabel":"string | null"},"errorId":{"type":"string","description":"Error ID if the message has an error","uniqueKey":"errorId","typeLabel":"string"},"errorText":{"type":"string","description":"Error text if the message has an error","uniqueKey":"errorText","typeLabel":"string"},"payload":{"type":"object","description":"The payload that was used to send the notification trigger","additionalProperties":true,"uniqueKey":"payload","typeLabel":"object"},"overrides":{"type":"object","description":"Provider specific overrides used when triggering the notification","additionalProperties":true,"uniqueKey":"overrides","typeLabel":"object"},"contextKeys":{"description":"Context (single or multi) in which the message was sent","example":["tenant:org-123","region:us-east-1"],"type":"array","items":{"type":"string","uniqueKey":"contextKeys.items.[INDEX]","typeLabel":"string"},"uniqueKey":"contextKeys","typeLabel":"string[]"}},"required":["_environmentId","_organizationId","_notificationId","_subscriberId","createdAt","transactionId","channel","read","seen","cta","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_environmentId":"\u003cstring>","_organizationId":"\u003cstring>","_notificationId":"\u003cstring>","_subscriberId":"\u003cstring>","createdAt":"\u003cstring>","transactionId":"\u003cstring>","channel":"in_app","read":true,"seen":true,"cta":{"type":"redirect","data":{"url":"\u003cstring>"},"action":{"status":"pending","buttons":[{"type":"primary","content":"\u003cstring>","resultContent":"\u003cstring>"}],"result":{"payload":{},"type":"primary"}}},"status":"sent","_id":"\u003cstring>","_templateId":"\u003cstring>","_messageTemplateId":"\u003cstring>","subscriber":{"subscriberId":"\u003cstring>","_organizationId":"\u003cstring>","_environmentId":"\u003cstring>","deleted":true,"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","_id":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","avatar":"\u003cstring>","locale":"\u003cstring>","channels":[{"providerId":"slack","credentials":{"webhookUrl":"https://example.com/webhook","channel":"general","deviceTokens":["token1","token2","token3"],"alertUid":"12345-abcde","title":"Critical Alert","imageUrl":"https://example.com/image.png","state":"resolved","externalUrl":"https://example.com/details"},"_integrationId":"\u003cstring>","integrationIdentifier":"\u003cstring>"}],"topics":["\u003cstring>"],"isOnline":true,"lastOnlineAt":"\u003cstring>","__v":123,"data":{},"timezone":"\u003cstring>"},"template":{"name":"\u003cstring>","description":"\u003cstring>","active":true,"draft":true,"preferenceSettings":{"email":true,"sms":false,"in_app":true,"chat":false,"push":true,"tool":true},"critical":true,"tags":["\u003cstring>"],"steps":[{"_id":"\u003cstring>","uuid":"\u003cstring>","name":"\u003cstring>","_templateId":"\u003cstring>","active":true,"shouldStopOnFail":true,"template":{},"filters":[{"isNegated":true,"type":"BOOLEAN","value":"AND","children":[{"field":"\u003cstring>","value":"\u003cstring>","operator":"LARGER","on":"subscriber"}]}],"_parentId":"\u003cstring>","metadata":{"type":"regular","amount":123,"unit":"seconds","digestKey":"\u003cstring>","backoff":true,"backoffAmount":123,"backoffUnit":"seconds","updateMode":true},"replyCallback":{"active":true,"url":"\u003cstring>"},"variants":[{"_id":"\u003cstring>","uuid":"\u003cstring>","name":"\u003cstring>","_templateId":"\u003cstring>","active":true,"shouldStopOnFail":true,"template":{},"filters":[{"isNegated":true,"type":"BOOLEAN","value":"AND","children":[{"field":"\u003cstring>","value":"\u003cstring>","operator":"LARGER","on":"subscriber"}]}],"_parentId":"\u003cstring>","metadata":{"type":"regular","amount":123,"unit":"seconds","digestKey":"\u003cstring>","backoff":true,"backoffAmount":123,"backoffUnit":"seconds","updateMode":true},"replyCallback":{"active":true,"url":"\u003cstring>"}}]}],"_organizationId":"\u003cstring>","_creatorId":"\u003cstring>","_environmentId":"\u003cstring>","triggers":[{"type":"event","identifier":"\u003cstring>","variables":[{"name":"\u003cstring>"}],"subscriberVariables":[{"name":"\u003cstring>"}]}],"_notificationGroupId":"\u003cstring>","deleted":true,"deletedAt":"\u003cstring>","deletedBy":"\u003cstring>","_id":"\u003cstring>","_parentId":"\u003cstring>","notificationGroup":{"name":"\u003cstring>","_environmentId":"\u003cstring>","_organizationId":"\u003cstring>","_id":"\u003cstring>","_parentId":"\u003cstring>"},"data":{},"workflowIntegrationStatus":{}},"templateIdentifier":"\u003cstring>","deliveredAt":["\u003cstring>"],"lastSeenDate":"\u003cstring>","lastReadDate":"\u003cstring>","content":[{"type":"button","content":"\u003cstring>","url":"\u003cstring>","styles":{"textAlign":"center"}}],"subject":"\u003cstring>","snoozedUntil":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","directWebhookUrl":"\u003cstring>","providerId":"\u003cstring>","deviceTokens":["\u003cstring>"],"title":"\u003cstring>","_feedId":"\u003cstring>","errorId":"\u003cstring>","errorText":"\u003cstring>","payload":{},"overrides":{},"contextKeys":["tenant:org-123","region:us-east-1"]}}},"exampleType":"generated"}},"exampleType":"generated"},"93d35f47-de60-4715-a828-70a26dafa1c2":{"description":"Bad Request","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"5846473b-89f5-4213-b1f4-101a7e2b8f80":{"description":"Unauthorized","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"4418c58d-6c54-41cb-9ac0-e748bab81360":{"description":"Forbidden","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"6b012b19-c088-47b8-892a-b063b05ff970":{"description":"Not Found","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"50a344f2-a6e1-46b2-884a-36ddca7b0231":{"description":"Method Not Allowed","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"58ff2b81-1643-4eae-a76f-06ac770ab5e6":{"description":"Conflict","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"b5fad3af-3a18-4e86-99a3-b5d3c591533d":{"description":"Payload Too Large","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"3450463a-bf12-47b9-b307-35eeccb88fbe":{"description":"URI Too Long","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"e2e8387c-df16-4da3-931d-232fbf058f73":{"description":"Unsupported Media Type","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"898e7aba-8d31-489f-8656-6291dc77b6cc":{"description":"Unprocessable Entity","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"errors":{"type":"object","description":"A record of validation errors keyed by field name","additionalProperties":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.messages.items.[INDEX]","typeLabel":"string"},"description":"List of validation error messages","example":["Field is required","Invalid format"],"isRequired":true,"uniqueKey":"errors.additionalProperties.messages","typeLabel":"string[]"},"value":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.4","typeLabel":"object"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.5","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"errors.additionalProperties.value","typeLabel":"string | null | number | boolean | object | (string | null | number | boolean | object)[]"}},"required":["messages"],"uniqueKey":"errors.additionalProperties","typeLabel":"object"},"example":{"fieldName1":{"messages":["Field is required","Must be a valid email address"],"value":"invalidEmail"},"fieldName2":{"messages":["Must be at least 18 years old"],"value":17},"fieldName3":{"messages":["Must be a boolean value"],"value":true},"fieldName4":{"messages":["Must be a valid object"],"value":{"key":"value"}},"fieldName5":{"messages":["Field is missing"],"value":null},"fieldName6":{"messages":["Undefined value"]}},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","errors":{"fieldName1":{"messages":["Field is required","Must be a valid email address"],"value":"invalidEmail"},"fieldName2":{"messages":["Must be at least 18 years old"],"value":17},"fieldName3":{"messages":["Must be a boolean value"],"value":true},"fieldName4":{"messages":["Must be a valid object"],"value":{"key":"value"}},"fieldName5":{"messages":["Field is missing"],"value":null},"fieldName6":{"messages":["Undefined value"]}},"message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"5356046e-0b21-4fb1-a0fb-877c919424bf":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"},"Retry-After":{"required":false,"description":"The number of seconds after which the client may retry the request that was previously rejected.","schema":{"type":"string"},"example":"8"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"API rate limit exceeded"}},"exampleType":"generated"}},"exampleType":"generated"},"2e6803dd-9066-41b2-b575-35f807e645ff":{"description":"Internal Server Error","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"7668042c-b2fb-4ed2-8f41-f42705ef2f8c":{"description":"The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"},"Retry-After":{"required":false,"description":"The number of seconds after which the client may retry the request that was previously rejected.","schema":{"type":"string"},"example":"8"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Please wait some time, then try again."}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3ba3a254-a44a-4ac0-bd26-1035042db7a2":{"secretKey":{"type":"apiKey","name":"Authorization","in":"header","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","x-speakeasy-example":"YOUR_SECRET_KEY_HERE","scopes":[]}}},"servers":{"29cc13d7-64c7-40f9-8a35-9c01537b78f4":{"url":"https://api.novu.co"},"7588375a-aa7e-462d-a5bf-d94b8564f985":{"url":"https://eu.api.novu.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","x-speakeasy-example":"YOUR_SECRET_KEY_HERE","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"secretKey","name":"Authorization"}],"title":"secretKey"}]},"originalFileLocation":"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"},"subdomain":"novu-c5de82d9","siteName":"Novu","title":"Update notification action status - Novu","contextualStarterQuestions":[{"_id":"6a46178e1acb1ee4e52cb96e","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"Can I mark notifications as read?","status":"active","generatedBy":"contextual","path":"api-reference/subscribers/update-notification-action-status","createdAt":"2026-07-02T07:47:26.901Z","updatedAt":"2026-07-02T07:47:26.901Z","__v":0},{"_id":"6a46178e1acb1ee4e52cb96d","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"What auth header is required?","status":"active","generatedBy":"contextual","path":"api-reference/subscribers/update-notification-action-status","createdAt":"2026-07-02T07:47:26.901Z","updatedAt":"2026-07-02T07:47:26.901Z","__v":0},{"_id":"6a46178e1acb1ee4e52cb96c","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"How do I update action status?","status":"active","generatedBy":"contextual","path":"api-reference/subscribers/update-notification-action-status","createdAt":"2026-07-02T07:47:26.901Z","updatedAt":"2026-07-02T07:47:26.901Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-09T07:59:59.290Z","originalFileLocation":"api-reference/subscribers/update-notification-action-status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"system\"}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=\"This API is deprecated, use v2 API instead. Update in-app notification\u0026#x27;s action status by its unique key identifier messageId and type field type. type field can be primary or secondary\">\u003cmeta data-mint-head name=\"application-name\" content=\"Novu\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_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=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update notification action status - Novu\">\u003cmeta data-mint-head property=\"og:description\" content=\"This API is deprecated, use v2 API instead. Update in-app notification\u0026#x27;s action status by its unique key identifier messageId and type field type. type field can be primary or secondary\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Novu\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Notification+state\u0026amp;title=Update+notification+action+status\u0026amp;description=This+API+is+deprecated%2C+use+v2+API+instead.+Update+in-app+notification%27s+action+status+by+its+unique+key+identifier+**messageId**+and+type+field+**type**.+%0A++++\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=3c3478bfc4669999c6cbda2c3b72ed81c743569ab105c49579d71fa7ecd236b7\">\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=\"Update notification action status - Novu\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This API is deprecated, use v2 API instead. Update in-app notification\u0026#x27;s action status by its unique key identifier messageId and type field type. type field can be primary or secondary\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Notification+state\u0026amp;title=Update+notification+action+status\u0026amp;description=This+API+is+deprecated%2C+use+v2+API+instead.+Update+in-app+notification%27s+action+status+by+its+unique+key+identifier+**messageId**+and+type+field+**type**.+%0A++++\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=3c3478bfc4669999c6cbda2c3b72ed81c743569ab105c49579d71fa7ecd236b7\">\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=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Novu\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0e121b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscribers/update-notification-action-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.novu.co/#organization\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.novu.co#website\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status#webpage\",\"url\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status\",\"name\":\"Update notification action status\",\"description\":\"This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier messageId and type field type. type field can be primary or secondary\",\"dateModified\":\"2026-07-09T07:59:59.290Z\",\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data\",\"item\":\"https://docs.novu.co/api-reference/subscribers/subscriber-schema\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscribers\",\"item\":\"https://docs.novu.co/api-reference/subscribers/subscriber-schema\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Notification state\",\"item\":\"https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-notifications\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update notification action status\",\"item\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status#apireference\",\"headline\":\"Update notification action status\",\"name\":\"Update notification action status\",\"description\":\"This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier messageId and type field type. type field can be primary or secondary\",\"url\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.novu.co/api-reference/subscribers/update-notification-action-status#webpage\"},\"dateModified\":\"2026-07-09T07:59:59.290Z\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Novu\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Novu","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Notify","pages":[{"title":"Notify","href":"/platform"}]},{"tab":"Agent Connect","pages":[{"title":"Agent Connect","href":"/agents"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Novu REST API Reference","sidebarTitle":"Overview","href":"/api-reference"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Payload Limits","href":"/api-reference/payload-limits"}]},{"group":"Notification delivery","icon":"send","pages":[{"group":"Events","expanded":false,"pages":[{"title":"Trigger event","openapi":"POST /v1/events/trigger","href":"/api-reference/events/trigger-event"},{"title":"Bulk trigger event","openapi":"POST /v1/events/trigger/bulk","href":"/api-reference/events/bulk-trigger-event"},{"title":"Broadcast event to all","openapi":"POST /v1/events/trigger/broadcast","href":"/api-reference/events/broadcast-event-to-all"},{"title":"Cancel triggered event","openapi":"DELETE /v1/events/trigger/{transactionId}","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Notifications","expanded":false,"pages":[{"title":"Notification event schema","sidebarTitle":"Schema","href":"/api-reference/notifications/notification-event-schema"},{"title":"List all events","openapi":"GET /v1/notifications","href":"/api-reference/notifications/list-all-events"},{"title":"Retrieve an event","openapi":"GET /v1/notifications/{notificationId}","href":"/api-reference/notifications/retrieve-an-event"}]},{"group":"Messages","expanded":false,"pages":[{"title":"Message schema","sidebarTitle":"Schema","href":"/api-reference/messages/message-schema"},{"title":"List all messages","openapi":"GET /v1/messages","href":"/api-reference/messages/list-all-messages"},{"title":"Delete a message","openapi":"DELETE /v1/messages/{messageId}","href":"/api-reference/messages/delete-a-message"},{"title":"Delete messages by transactionId","openapi":"DELETE /v1/messages/transaction/{transactionId}","href":"/api-reference/messages/delete-messages-by-transactionid"}]},{"group":"Activity","expanded":false,"pages":[{"title":"Track activity and engagement events","openapi":"POST /v2/inbound-webhooks/delivery-providers/{environmentId}/{integrationId}","href":"/api-reference/activity/track-activity-and-engagement-events"}]}]},{"group":"Agents","icon":"bot","pages":[{"title":"Agent schema","sidebarTitle":"Schema","href":"/api-reference/agents/agent-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create an agent","openapi":"POST /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"List all agents","openapi":"GET /v1/agents","href":"/api-reference/agents/list-all-agents"},{"title":"Retrieve an agent","openapi":"GET /v1/agents/{identifier}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Update an agent","openapi":"PATCH /v1/agents/{identifier}","href":"/api-reference/agents/update-an-agent"},{"title":"Delete an agent","openapi":"DELETE /v1/agents/{identifier}","href":"/api-reference/agents/delete-an-agent"}]},{"group":"Runtime","expanded":false,"pages":[{"title":"Update an agent bridge","openapi":"PUT /v1/agents/{identifier}/bridge","href":"/api-reference/agents/update-an-agent-bridge"},{"title":"Send an agent reply","openapi":"POST /v1/agents/{agentId}/reply","href":"/api-reference/agents/send-an-agent-reply"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Create an agent integration","openapi":"POST /v1/agents/{identifier}/integrations","href":"/api-reference/agents/create-an-agent-integration"},{"title":"List agent integrations","openapi":"GET /v1/agents/{identifier}/integrations","href":"/api-reference/agents/list-agent-integrations"},{"title":"Update an agent integration","openapi":"PATCH /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/update-an-agent-integration"},{"title":"Delete an agent integration","openapi":"DELETE /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/delete-an-agent-integration"}]}]},{"group":"Data","icon":"database","pages":[{"group":"Subscribers","expanded":false,"pages":[{"title":"Subscriber schema","sidebarTitle":"Schema","href":"/api-reference/subscribers/subscriber-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a subscriber","openapi":"POST /v2/subscribers","href":"/api-reference/subscribers/create-a-subscriber"},{"title":"Retrieve a subscriber","openapi":"GET /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/retrieve-a-subscriber"},{"title":"Update a subscriber","openapi":"PATCH /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/update-a-subscriber"},{"title":"Delete a subscriber","openapi":"DELETE /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/delete-a-subscriber"},{"title":"Search subscribers","openapi":"GET /v2/subscribers","href":"/api-reference/subscribers/search-subscribers"},{"title":"Bulk create subscribers","openapi":"POST /v1/subscribers/bulk","href":"/api-reference/subscribers/bulk-create-subscribers"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Retrieve subscriber subscriptions","openapi":"GET /v2/subscribers/{subscriberId}/subscriptions","href":"/api-reference/subscribers/retrieve-subscriber-subscriptions"}]},{"group":"Preferences","expanded":false,"pages":[{"title":"Retrieve subscriber preferences","openapi":"GET /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/retrieve-subscriber-preferences"},{"title":"Update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/update-subscriber-preferences"},{"title":"Bulk update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences/bulk","href":"/api-reference/subscribers/bulk-update-subscriber-preferences"}]},{"group":"Credentials","expanded":false,"pages":[{"title":"Update provider credentials","openapi":"PUT /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/update-provider-credentials"},{"title":"Upsert provider credentials","openapi":"PATCH /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/upsert-provider-credentials"},{"title":"Delete provider credentials","openapi":"DELETE /v1/subscribers/{subscriberId}/credentials/{providerId}","href":"/api-reference/subscribers/delete-provider-credentials"}]},{"group":"Notification state","expanded":false,"pages":[{"title":"Retrieve subscriber notifications","openapi":"GET /v1/subscribers/{subscriberId}/notifications/feed","href":"/api-reference/subscribers/retrieve-subscriber-notifications"},{"title":"Update notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-as","href":"/api-reference/subscribers/update-notifications-state"},{"title":"Update all notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-all","href":"/api-reference/subscribers/update-all-notifications-state"},{"title":"Update subscriber online status","openapi":"PATCH /v1/subscribers/{subscriberId}/online-status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"title":"Retrieve unseen notifications count","openapi":"GET /v1/subscribers/{subscriberId}/notifications/unseen","description":"This API is deprecated, use v2 API instead. Retrieve unseen in-app notifications count for a subscriber by its unique key identifier **subscriberId**.","href":"/api-reference/subscribers/retrieve-unseen-notifications-count"},{"title":"Update notification action status","openapi":"POST /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","href":"/api-reference/subscribers/update-notification-action-status"}]}]},{"group":"Inbox","expanded":false,"pages":[{"group":"Counts","expanded":false,"pages":[{"title":"Retrieve subscriber notifications count","openapi":"GET /v2/subscribers/{subscriberId}/notifications/count","description":"Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**. \n Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys.","href":"/api-reference/subscribers/retrieve-subscriber-notifications-count"}]},{"group":"Read \u0026 seen","expanded":false,"pages":[{"title":"Mark a notification as read","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/read","href":"/api-reference/subscribers/mark-a-notification-as-read"},{"title":"Mark a notification as unread","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unread","href":"/api-reference/subscribers/mark-a-notification-as-unread"},{"title":"Mark all notifications as read","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read","href":"/api-reference/subscribers/mark-all-notifications-as-read"},{"title":"Mark notifications as seen","openapi":"POST /v2/subscribers/{subscriberId}/notifications/seen","href":"/api-reference/subscribers/mark-notifications-as-seen"}]},{"group":"Snooze","expanded":false,"pages":[{"title":"Snooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/snooze","href":"/api-reference/subscribers/snooze-a-notification"},{"title":"Unsnooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unsnooze","href":"/api-reference/subscribers/unsnooze-a-notification"}]},{"group":"Archive","expanded":false,"pages":[{"title":"Archive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/archive","href":"/api-reference/subscribers/archive-a-notification"},{"title":"Unarchive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unarchive","href":"/api-reference/subscribers/unarchive-a-notification"},{"title":"Archive all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/archive","href":"/api-reference/subscribers/archive-all-notifications"},{"title":"Archive all read notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read-archive","href":"/api-reference/subscribers/archive-all-read-notifications"}]},{"group":"Delete","expanded":false,"pages":[{"title":"Delete a notification","openapi":"DELETE /v2/subscribers/{subscriberId}/notifications/{notificationId}","href":"/api-reference/subscribers/delete-a-notification"},{"title":"Delete all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/delete","href":"/api-reference/subscribers/delete-all-notifications"}]},{"group":"Actions","expanded":false,"pages":[{"title":"Complete a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/complete","href":"/api-reference/subscribers/complete-a-notification-action"},{"title":"Revert a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/revert","href":"/api-reference/subscribers/revert-a-notification-action"}]}]},{"group":"Topics","expanded":false,"pages":[{"title":"Topic schema","sidebarTitle":"Schema","href":"/api-reference/topics/topic-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a topic","openapi":"POST /v2/topics","href":"/api-reference/topics/create-a-topic"},{"title":"Retrieve a topic","openapi":"GET /v2/topics/{topicKey}","href":"/api-reference/topics/retrieve-a-topic"},{"title":"Update a topic","openapi":"PATCH /v2/topics/{topicKey}","href":"/api-reference/topics/update-a-topic"},{"title":"Delete a topic","openapi":"DELETE /v2/topics/{topicKey}","href":"/api-reference/topics/delete-a-topic"},{"title":"List all topics","openapi":"GET /v2/topics","href":"/api-reference/topics/list-all-topics"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Create topic subscriptions","openapi":"POST /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/create-topic-subscriptions"},{"title":"Delete topic subscriptions","openapi":"DELETE /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/delete-topic-subscriptions"},{"title":"Update a topic subscription","openapi":"PATCH /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/update-a-topic-subscription"},{"title":"List topic subscriptions","openapi":"GET /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/list-topic-subscriptions"},{"title":"Check topic subscriber","openapi":"GET /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","href":"/api-reference/topics/check-topic-subscriber"},{"title":"Retrieve a topic subscription","openapi":"GET /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/retrieve-a-topic-subscription"}]}]},{"group":"Contexts","expanded":false,"pages":[{"title":"Context schema","sidebarTitle":"Schema","href":"/api-reference/contexts/context-schema"},{"title":"Create a context","openapi":"POST /v2/contexts","href":"/api-reference/contexts/create-a-context"},{"title":"Retrieve a context","openapi":"GET /v2/contexts/{type}/{id}","href":"/api-reference/contexts/retrieve-a-context"},{"title":"Update a context","openapi":"PATCH /v2/contexts/{type}/{id}","href":"/api-reference/contexts/update-a-context"},{"title":"Delete a context","openapi":"DELETE /v2/contexts/{type}/{id}","href":"/api-reference/contexts/delete-a-context"},{"title":"List all contexts","openapi":"GET /v2/contexts","href":"/api-reference/contexts/list-all-contexts"}]},{"group":"Channel Connections","expanded":false,"pages":[{"title":"Create a channel connection","openapi":"POST /v1/channel-connections","href":"/api-reference/channel-connections/create-a-channel-connection"},{"title":"Retrieve a channel connection","openapi":"GET /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/retrieve-a-channel-connection"},{"title":"Update a channel connection","openapi":"PATCH /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/update-a-channel-connection"},{"title":"Delete a channel connection","openapi":"DELETE /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/delete-a-channel-connection"},{"title":"List all channel connections","openapi":"GET /v1/channel-connections","href":"/api-reference/channel-connections/list-all-channel-connections"}]},{"group":"Channel Endpoints","expanded":false,"pages":[{"title":"Create a channel endpoint","openapi":"POST /v1/channel-endpoints","href":"/api-reference/channel-endpoints/create-a-channel-endpoint"},{"title":"Retrieve a channel endpoint","openapi":"GET /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/retrieve-a-channel-endpoint"},{"title":"Update a channel endpoint","openapi":"PATCH /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/update-a-channel-endpoint"},{"title":"Delete a channel endpoint","openapi":"DELETE /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/delete-a-channel-endpoint"},{"title":"List all channel endpoints","openapi":"GET /v1/channel-endpoints","href":"/api-reference/channel-endpoints/list-all-channel-endpoints"}]}]},{"group":"Workflows \u0026 content","icon":"git-branch","pages":[{"group":"Workflows","expanded":false,"pages":[{"title":"Workflow schema","sidebarTitle":"Schema","href":"/api-reference/workflows/workflow-schema"},{"title":"Create a workflow","openapi":"POST /v2/workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Retrieve a workflow","openapi":"GET /v2/workflows/{workflowId}","href":"/api-reference/workflows/retrieve-a-workflow"},{"title":"Update a workflow","openapi":"PUT /v2/workflows/{workflowId}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","openapi":"DELETE /v2/workflows/{workflowId}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"List all workflows","openapi":"GET /v2/workflows","href":"/api-reference/workflows/list-all-workflows"},{"title":"Sync a workflow","openapi":"PUT /v2/workflows/{workflowId}/sync","href":"/api-reference/workflows/sync-a-workflow"},{"title":"Retrieve workflow step","openapi":"GET /v2/workflows/{workflowId}/steps/{stepId}","href":"/api-reference/workflows/retrieve-workflow-step"},{"title":"Generate a step preview","openapi":"POST /v2/workflows/{workflowId}/step/{stepId}/preview","href":"/api-reference/workflows/generate-a-step-preview"}]},{"group":"Translations","expanded":false,"pages":[{"title":"Create a translation","openapi":"POST /v2/translations","href":"/api-reference/translations/create-a-translation"},{"title":"Retrieve a translation","openapi":"GET /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/retrieve-a-translation"},{"title":"Delete a translation","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/delete-a-translation"},{"title":"Retrieve a translation group","openapi":"GET /v2/translations/group/{resourceType}/{resourceId}","href":"/api-reference/translations/retrieve-a-translation-group"},{"title":"Delete a translation group","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}","href":"/api-reference/translations/delete-a-translation-group"},{"title":"Import master translations JSON","openapi":"POST /v2/translations/master-json","href":"/api-reference/translations/import-master-translations-json"},{"title":"Retrieve master translations JSON","openapi":"GET /v2/translations/master-json","href":"/api-reference/translations/retrieve-master-translations-json"},{"title":"Upload master translations JSON file","openapi":"POST /v2/translations/master-json/upload","href":"/api-reference/translations/upload-master-translations-json-file"},{"title":"Upload translation files","openapi":"POST /v2/translations/upload","href":"/api-reference/translations/upload-translation-files"}]},{"group":"Layouts","expanded":false,"pages":[{"title":"Create a layout","openapi":"POST /v2/layouts","href":"/api-reference/layouts/create-a-layout"},{"title":"Delete a layout","openapi":"DELETE /v2/layouts/{layoutId}","href":"/api-reference/layouts/delete-a-layout"},{"title":"Duplicate a layout","openapi":"POST /v2/layouts/{layoutId}/duplicate","href":"/api-reference/layouts/duplicate-a-layout"},{"title":"Generate layout preview","openapi":"POST /v2/layouts/{layoutId}/preview","href":"/api-reference/layouts/generate-layout-preview"},{"title":"Get layout usage","openapi":"GET /v2/layouts/{layoutId}/usage","href":"/api-reference/layouts/get-layout-usage"},{"title":"List all layouts","openapi":"GET /v2/layouts","href":"/api-reference/layouts/list-all-layouts"},{"title":"Retrieve a layout","openapi":"GET /v2/layouts/{layoutId}","href":"/api-reference/layouts/retrieve-a-layout"},{"title":"Update a layout","openapi":"PUT /v2/layouts/{layoutId}","href":"/api-reference/layouts/update-a-layout"}]}]},{"group":"Platform \u0026 channels","icon":"settings","pages":[{"group":"Environments","expanded":false,"pages":[{"title":"Environment schema","sidebarTitle":"Schema","href":"/api-reference/environments/environment-schema"},{"title":"Create an environment","openapi":"POST /v1/environments","href":"/api-reference/environments/create-an-environment"},{"title":"Update an environment","openapi":"PUT /v1/environments/{environmentId}","href":"/api-reference/environments/update-an-environment"},{"title":"Delete an environment","openapi":"DELETE /v1/environments/{environmentId}","href":"/api-reference/environments/delete-an-environment"},{"title":"List all environments","openapi":"GET /v1/environments","href":"/api-reference/environments/list-all-environments"},{"title":"List environment tags","openapi":"GET /v2/environments/{environmentId}/tags","href":"/api-reference/environments/list-environment-tags"},{"title":"Compare resources between environments","openapi":"POST /v2/environments/{targetEnvironmentId}/diff","href":"/api-reference/environments/compare-resources-between-environments"},{"title":"Publish resources to target environment","openapi":"POST /v2/environments/{targetEnvironmentId}/publish","href":"/api-reference/environments/publish-resources-to-target-environment"}]},{"group":"Environment Variables","expanded":false,"pages":[{"title":"Environment variable schema","sidebarTitle":"Schema","href":"/api-reference/environment-variables/environment-variable-schema"},{"title":"Create a variable","openapi":"POST /v1/environment-variables","href":"/api-reference/environment-variables/create-a-variable"},{"title":"Retrieve a variable","openapi":"GET /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/retrieve-a-variable"},{"title":"Update a variable","openapi":"PATCH /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/update-a-variable"},{"title":"Delete a variable","openapi":"DELETE /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/delete-a-variable"},{"title":"List all variables","openapi":"GET /v1/environment-variables","href":"/api-reference/environment-variables/list-all-variables"},{"title":"Retrieve a variable usage","openapi":"GET /v1/environment-variables/{variableKey}/usage","href":"/api-reference/environment-variables/retrieve-a-variable-usage"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Integration schema","sidebarTitle":"Schema","href":"/api-reference/integrations/integration-schema"},{"title":"Create an integration","openapi":"POST /v1/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Update an integration","openapi":"PUT /v1/integrations/{integrationId}","href":"/api-reference/integrations/update-an-integration"},{"title":"Delete an integration","openapi":"DELETE /v1/integrations/{integrationId}","href":"/api-reference/integrations/delete-an-integration"},{"title":"List all integrations","openapi":"GET /v1/integrations","href":"/api-reference/integrations/list-all-integrations"},{"title":"List active integrations","openapi":"GET /v1/integrations/active","href":"/api-reference/integrations/list-active-integrations"},{"title":"Update integration as primary","openapi":"POST /v1/integrations/{integrationId}/set-primary","href":"/api-reference/integrations/update-integration-as-primary"},{"title":"Generate chat OAuth URL","openapi":"POST /v1/integrations/chat/oauth","href":"/api-reference/integrations/generate-chat-oauth-url"},{"title":"Auto-configure an integration for inbound webhooks","openapi":"POST /v1/integrations/{integrationId}/auto-configure","href":"/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks"}]}]}]},{"tab":"Resources","menu":[{"item":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"item":"Framework","pages":[{"title":"Framework","href":"/framework"}]},{"item":"Community","pages":[{"title":"Community","href":"/community"}]}],"pages":[{"title":"Resources","href":"/guides"}]}]},"title":"Update notification action status - Novu","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}