Builds a schedule from the project’s defaults and the body. A project’s second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.
Legacy: a UTC hour. Moves the schedule to the next occurrence of that hour and repeats it in UTC. Ignored when startsAt is set; prefer startsAt + timezone.
IANA time zone the schedule repeats in (e.g. America/New_York), so runs keep their wall-clock time across daylight saving changes. Send it with startsAt: changing an existing schedule's zone without a start time is a 400. Defaults to the current zone, or UTC for a new schedule.
Whether the plan allows more than one active schedule per project.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenLens","description":"Track brand visibility across the 7 AI platforms customers actually use.","colors":{"primary":"#1a6b54","light":"#b8ddd2","dark":"#1a6b54"},"favicon":"https://mintcdn.com/breadtechnologiesinc/VVJOBPs8Sz8x7Yxj/favicon.svg?fit=max\u0026auto=format\u0026n=VVJOBPs8Sz8x7Yxj\u0026q=85\u0026s=476d3a3953da700935ec0e63e9d9d7db","footer":{"socials":{"x":"https://x.com/openlens","github":"https://github.com/Bread-Technologies/OpenLens"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breadtechnologiesinc","hasAudioNarration":false,"actualSubdomain":"breadtechnologiesinc","customDomains":["docs.openlens.com"],"gitSource":{"type":"github","owner":"bread-technologies","repo":"openlens","deployBranch":"dev","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6add74b84a5b340ece6ca473","collectionId":"d63ed658-e1ea-41bb-b74d-1d0cf11a9854","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6add74b84a5b340ece6ca473"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6addc526fbe3b12122267d6d","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":45},{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Resources","count":27},{"language":"default","tag":"Web UI manual","count":14},{"language":"default","tag":"Runs","count":5},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Organizations","count":4},{"language":"default","tag":"Account","count":4},{"language":"default","tag":"Metrics","count":4},{"language":"default","tag":"Changelog","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/resources/add-a-schedule-to-the-project","slug":"/api-reference/resources/add-a-schedule-to-the-project","pageMetadata":{"title":"Add a schedule to the project","description":"Builds a schedule from the project's defaults and the body. A project's second schedule needs a plan with multiple schedules (Agency); otherwise 402 `MULTIPLE_SCHEDULES_NOT_ALLOWED`. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 `SCHEDULE_LIMIT_REACHED`. Answers with every schedule of the project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects/{id}/schedules","href":"/api-reference/resources/add-a-schedule-to-the-project","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Builds a schedule from the project’s defaults and the body. A project’s second schedule needs a plan with multiple schedules (Agency); otherwise 402 \", _jsx(_components.code, {\n children: \"MULTIPLE_SCHEDULES_NOT_ALLOWED\"\n }), \". A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 \", _jsx(_components.code, {\n children: \"SCHEDULE_LIMIT_REACHED\"\n }), \". Answers with every schedule of the project.\"]\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":"Add a schedule to the project","description":"Builds a schedule from the project's defaults and the body. A project's second schedule needs a plan with multiple schedules (Agency); otherwise 402 `MULTIPLE_SCHEDULES_NOT_ALLOWED`. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 `SCHEDULE_LIMIT_REACHED`. Answers with every schedule of the project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects/{id}/schedules","href":"/api-reference/resources/add-a-schedule-to-the-project","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Resources"],"summary":"Add a schedule to the project","description":"Builds a schedule from the project's defaults and the body. A project's second schedule needs a plan with multiple schedules (Agency); otherwise 402 `MULTIPLE_SCHEDULES_NOT_ALLOWED`. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 `SCHEDULE_LIMIT_REACHED`. Answers with every schedule of the project.","parameters":["ca8d995a-ec39-41d9-b8f7-f385a45b27d7"],"requestBody":"b98f1ac1-5739-487f-ae26-395d26ac1134","responses":{"201":"94d38b30-eda8-49b3-abdb-aeafe2f18bdb","400":"e0c4ef03-cf46-4fd4-9690-6573e2f23071","401":"946f8eb9-b3a7-4ea4-b0ee-dcafef859607","402":"eb7ee146-61e6-41ae-85f6-8dfb4d1db701","404":"c9e55fae-fe13-424f-930e-ff2725e1056f","429":"c077ec8c-8ffd-4829-b7c4-d3222403a57b","500":"f34a5ff4-9501-4f08-ba3b-2fa39e420472","503":"6e82e4ba-ede4-47de-9bb5-f51c70d65044"},"method":"post","type":"path","servers":["ebb5f2df-1467-4f50-9c9b-ef0c626f0ea4"],"security":["3960d47c-0a09-42b0-9e70-2e12733ab090"],"path":"/projects/{id}/schedules","baseUrlOptions":["https://openlens.com/api"],"title":"Add a schedule to the project","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ca8d995a-ec39-41d9-b8f7-f385a45b27d7":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Optional label (up to 80 characters); null clears it.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional label (up to 80 characters); null clears it.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"enabled":{"type":"boolean","uniqueKey":"enabled","typeLabel":"boolean"},"frequency":{"type":"string","enum":["daily","weekly","monthly"],"uniqueKey":"frequency","typeLabel":"enum\u003cstring>"},"hour":{"type":"integer","minimum":0,"maximum":23,"deprecated":true,"description":"Legacy: a UTC hour. Moves the schedule to the next occurrence of that hour and repeats it in UTC. Ignored when `startsAt` is set; prefer `startsAt` + `timezone`.","uniqueKey":"hour","typeLabel":"integer"},"startsAt":{"type":"string","format":"date-time","description":"The first run, as ISO 8601 with its UTC offset (e.g. `2026-11-02T09:00:00-05:00`). Within the next year.","uniqueKey":"startsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","description":"IANA time zone the schedule repeats in (e.g. `America/New_York`), so runs keep their wall-clock time across daylight saving changes. Send it with `startsAt`: changing an existing schedule's zone without a start time is a 400. Defaults to the current zone, or UTC for a new schedule.","uniqueKey":"timezone","typeLabel":"string"},"scope":{"type":"object","description":"What the schedule runs. Each field is optional.","properties":{"promptIds":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.promptIds.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","uniqueKey":"scope.promptIds.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","uniqueKey":"scope.promptIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"scope.promptIds","typeLabel":"string\u003cuuid>[] | null"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"scope.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"uniqueKey":"scope.platforms","typeLabel":"enum\u003cstring>[]"},"countryCodes":{"type":"array","items":{"type":"string","uniqueKey":"scope.countryCodes.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"ISO 3166-1 alpha-2 country codes. More than one needs a plan with multi-country reporting.","uniqueKey":"scope.countryCodes","typeLabel":"string[]"}},"uniqueKey":"scope","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","enabled":true,"hour":11,"startsAt":"2023-11-07T05:31:56Z","timezone":"\u003cstring>","scope":{"promptIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"platforms":[],"countryCodes":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"94d38b30-eda8-49b3-abdb-aeafe2f18bdb":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"schedules":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The schedule's ID; null until it is saved.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The schedule's ID; null until it is saved.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Optional label for telling a project's schedules apart.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional label for telling a project's schedules apart.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].name","typeLabel":"string | null"},"configured":{"type":"boolean","description":"False until a schedule is saved for the project.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].configured","typeLabel":"boolean"},"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"schedules.items.[INDEX].enabled","typeLabel":"boolean"},"frequency":{"type":"string","enum":["daily","weekly","monthly"],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].frequency","typeLabel":"enum\u003cstring>"},"hour":{"type":"integer","minimum":0,"maximum":23,"deprecated":true,"description":"UTC hour of `startsAt` (9 until configured). Prefer `startsAt` + `timezone`.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].hour","typeLabel":"integer"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","description":"The first run; later runs repeat from it in `timezone`. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The first run; later runs repeat from it in `timezone`. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time> | null"},"timezone":{"oneOf":[{"type":"string","description":"IANA time zone the schedule repeats in. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA time zone the schedule repeats in. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].timezone","typeLabel":"string | null"},"nextScheduledRunAt":{"oneOf":[{"type":"string","format":"date-time","description":"The next run while the schedule is on; null while it is off.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].nextScheduledRunAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The next run while the schedule is on; null while it is off.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].nextScheduledRunAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].nextScheduledRunAt","typeLabel":"string\u003cdate-time> | null"},"upcomingRunAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the schedule would run next, on or off: its next run, or the next occurrence of its start. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].upcomingRunAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the schedule would run next, on or off: its next run, or the next occurrence of its start. Null until configured.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].upcomingRunAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].upcomingRunAt","typeLabel":"string\u003cdate-time> | null"},"pauseReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"schedules.items.[INDEX].pauseReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"schedules.items.[INDEX].pauseReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].pauseReason","typeLabel":"string | null"},"allowedCadences":{"type":"array","items":{"type":"string","enum":["daily","weekly","monthly"],"uniqueKey":"schedules.items.[INDEX].allowedCadences.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"schedules.items.[INDEX].allowedCadences","typeLabel":"enum\u003cstring>[]"},"plan":{"type":"string","isRequired":true,"uniqueKey":"schedules.items.[INDEX].plan","typeLabel":"string"},"multiCountryEnabled":{"type":"boolean","description":"Whether the plan can schedule more than one country.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].multiCountryEnabled","typeLabel":"boolean"},"scope":{"type":"object","properties":{"promptIds":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"schedules.items.[INDEX].scope.promptIds.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope.promptIds.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope.promptIds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope.promptIds","typeLabel":"string\u003cuuid>[] | null"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"schedules.items.[INDEX].scope.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope.platforms","typeLabel":"enum\u003cstring>[]"},"countryCodes":{"type":"array","items":{"type":"string","uniqueKey":"schedules.items.[INDEX].scope.countryCodes.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"ISO 3166-1 alpha-2 country codes. More than one needs a plan with multi-country reporting.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope.countryCodes","typeLabel":"string[]"}},"required":["promptIds","platforms","countryCodes"],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].scope","typeLabel":"object"},"estimate":{"type":"object","description":"Inputs for the schedule's monthly credit estimate.","properties":{"activePrompts":{"type":"integer","description":"Active prompts the scope covers today.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].estimate.activePrompts","typeLabel":"integer"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"schedules.items.[INDEX].estimate.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"schedules.items.[INDEX].estimate.platforms","typeLabel":"enum\u003cstring>[]"},"countries":{"type":"integer","isRequired":true,"uniqueKey":"schedules.items.[INDEX].estimate.countries","typeLabel":"integer"},"pool":{"type":"number","description":"The organization's monthly credit pool.","isRequired":true,"uniqueKey":"schedules.items.[INDEX].estimate.pool","typeLabel":"number"}},"required":["activePrompts","platforms","countries","pool"],"isRequired":true,"uniqueKey":"schedules.items.[INDEX].estimate","typeLabel":"object"}},"required":["id","name","configured","enabled","frequency","hour","startsAt","timezone","nextScheduledRunAt","upcomingRunAt","pauseReason","allowedCadences","plan","multiCountryEnabled","scope","estimate"],"uniqueKey":"schedules.items.[INDEX]","typeLabel":"object"},"description":"The project's schedules, oldest first.","isRequired":true,"uniqueKey":"schedules","typeLabel":"object[]"},"draft":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The schedule's ID; null until it is saved.","isRequired":true,"uniqueKey":"draft.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The schedule's ID; null until it is saved.","isRequired":true,"uniqueKey":"draft.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Optional label for telling a project's schedules apart.","isRequired":true,"uniqueKey":"draft.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional label for telling a project's schedules apart.","isRequired":true,"uniqueKey":"draft.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.name","typeLabel":"string | null"},"configured":{"type":"boolean","description":"False until a schedule is saved for the project.","isRequired":true,"uniqueKey":"draft.configured","typeLabel":"boolean"},"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"draft.enabled","typeLabel":"boolean"},"frequency":{"type":"string","enum":["daily","weekly","monthly"],"isRequired":true,"uniqueKey":"draft.frequency","typeLabel":"enum\u003cstring>"},"hour":{"type":"integer","minimum":0,"maximum":23,"deprecated":true,"description":"UTC hour of `startsAt` (9 until configured). Prefer `startsAt` + `timezone`.","isRequired":true,"uniqueKey":"draft.hour","typeLabel":"integer"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","description":"The first run; later runs repeat from it in `timezone`. Null until configured.","isRequired":true,"uniqueKey":"draft.startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The first run; later runs repeat from it in `timezone`. Null until configured.","isRequired":true,"uniqueKey":"draft.startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.startsAt","typeLabel":"string\u003cdate-time> | null"},"timezone":{"oneOf":[{"type":"string","description":"IANA time zone the schedule repeats in. Null until configured.","isRequired":true,"uniqueKey":"draft.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA time zone the schedule repeats in. Null until configured.","isRequired":true,"uniqueKey":"draft.timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.timezone","typeLabel":"string | null"},"nextScheduledRunAt":{"oneOf":[{"type":"string","format":"date-time","description":"The next run while the schedule is on; null while it is off.","isRequired":true,"uniqueKey":"draft.nextScheduledRunAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The next run while the schedule is on; null while it is off.","isRequired":true,"uniqueKey":"draft.nextScheduledRunAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.nextScheduledRunAt","typeLabel":"string\u003cdate-time> | null"},"upcomingRunAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the schedule would run next, on or off: its next run, or the next occurrence of its start. Null until configured.","isRequired":true,"uniqueKey":"draft.upcomingRunAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the schedule would run next, on or off: its next run, or the next occurrence of its start. Null until configured.","isRequired":true,"uniqueKey":"draft.upcomingRunAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.upcomingRunAt","typeLabel":"string\u003cdate-time> | null"},"pauseReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"draft.pauseReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"draft.pauseReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.pauseReason","typeLabel":"string | null"},"allowedCadences":{"type":"array","items":{"type":"string","enum":["daily","weekly","monthly"],"uniqueKey":"draft.allowedCadences.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"draft.allowedCadences","typeLabel":"enum\u003cstring>[]"},"plan":{"type":"string","isRequired":true,"uniqueKey":"draft.plan","typeLabel":"string"},"multiCountryEnabled":{"type":"boolean","description":"Whether the plan can schedule more than one country.","isRequired":true,"uniqueKey":"draft.multiCountryEnabled","typeLabel":"boolean"},"scope":{"type":"object","properties":{"promptIds":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"draft.scope.promptIds.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","isRequired":true,"uniqueKey":"draft.scope.promptIds.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Prompts the schedule runs, or null for every active prompt, including ones added later.","isRequired":true,"uniqueKey":"draft.scope.promptIds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft.scope.promptIds","typeLabel":"string\u003cuuid>[] | null"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"draft.scope.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"isRequired":true,"uniqueKey":"draft.scope.platforms","typeLabel":"enum\u003cstring>[]"},"countryCodes":{"type":"array","items":{"type":"string","uniqueKey":"draft.scope.countryCodes.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"ISO 3166-1 alpha-2 country codes. More than one needs a plan with multi-country reporting.","isRequired":true,"uniqueKey":"draft.scope.countryCodes","typeLabel":"string[]"}},"required":["promptIds","platforms","countryCodes"],"isRequired":true,"uniqueKey":"draft.scope","typeLabel":"object"},"estimate":{"type":"object","description":"Inputs for the schedule's monthly credit estimate.","properties":{"activePrompts":{"type":"integer","description":"Active prompts the scope covers today.","isRequired":true,"uniqueKey":"draft.estimate.activePrompts","typeLabel":"integer"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"draft.estimate.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"draft.estimate.platforms","typeLabel":"enum\u003cstring>[]"},"countries":{"type":"integer","isRequired":true,"uniqueKey":"draft.estimate.countries","typeLabel":"integer"},"pool":{"type":"number","description":"The organization's monthly credit pool.","isRequired":true,"uniqueKey":"draft.estimate.pool","typeLabel":"number"}},"required":["activePrompts","platforms","countries","pool"],"isRequired":true,"uniqueKey":"draft.estimate","typeLabel":"object"}},"required":["id","name","configured","enabled","frequency","hour","startsAt","timezone","nextScheduledRunAt","upcomingRunAt","pauseReason","allowedCadences","plan","multiCountryEnabled","scope","estimate"],"description":"The defaults a new schedule starts from.","isRequired":true,"uniqueKey":"draft","typeLabel":"object"},"multipleSchedulesEnabled":{"type":"boolean","description":"Whether the plan allows more than one active schedule per project.","isRequired":true,"uniqueKey":"multipleSchedulesEnabled","typeLabel":"boolean"}},"required":["schedules","draft","multipleSchedulesEnabled"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"schedules":[{"id":"\u003cstring>","name":"\u003cstring>","configured":true,"enabled":true,"frequency":"daily","hour":11,"startsAt":"2023-11-07T05:31:56Z","timezone":"\u003cstring>","nextScheduledRunAt":"2023-11-07T05:31:56Z","upcomingRunAt":"2023-11-07T05:31:56Z","pauseReason":"\u003cstring>","allowedCadences":["daily"],"plan":"\u003cstring>","multiCountryEnabled":true,"scope":{"promptIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"platforms":["chatgpt"],"countryCodes":["\u003cstring>"]},"estimate":{"activePrompts":123,"platforms":["chatgpt"],"countries":123,"pool":123}}],"draft":{"id":"\u003cstring>","name":"\u003cstring>","configured":true,"enabled":true,"frequency":"daily","hour":11,"startsAt":"2023-11-07T05:31:56Z","timezone":"\u003cstring>","nextScheduledRunAt":"2023-11-07T05:31:56Z","upcomingRunAt":"2023-11-07T05:31:56Z","pauseReason":"\u003cstring>","allowedCadences":["daily"],"plan":"\u003cstring>","multiCountryEnabled":true,"scope":{"promptIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"platforms":["chatgpt"],"countryCodes":["\u003cstring>"]},"estimate":{"activePrompts":123,"platforms":["chatgpt"],"countries":123,"pool":123}},"multipleSchedulesEnabled":true}}},"exampleType":"generated"}},"exampleType":"generated"},"e0c4ef03-cf46-4fd4-9690-6573e2f23071":{"description":"Invalid schedule: a malformed field, an unknown time zone, a start more than a year out, an empty scope, prompts that aren't active in the project, platforms outside your plan, or a sixth schedule in the project (code `SCHEDULE_LIMIT_REACHED`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"946f8eb9-b3a7-4ea4-b0ee-dcafef859607":{"description":"Missing, malformed, or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"eb7ee146-61e6-41ae-85f6-8dfb4d1db701":{"description":"The change needs an upgrade: a cadence outside the plan (code `PLAN_CADENCE_NOT_ALLOWED`), several countries without multi-country support, more monthly credits than the pool has left (code `PROMPT_ALLOWANCE_RESERVATION`), or a second active schedule in the project on a plan without multiple schedules (code `MULTIPLE_SCHEDULES_NOT_ALLOWED`). Also returned when the tier's included API calls are used up (code `USAGE_LIMIT`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c9e55fae-fe13-424f-930e-ff2725e1056f":{"description":"Resource not found or not owned by your account.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c077ec8c-8ffd-4829-b7c4-d3222403a57b":{"description":"Rate limit, project cap, or daily quota hit. Body includes a `code` field.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f34a5ff4-9501-4f08-ba3b-2fa39e420472":{"description":"Server error. Retry; if persistent, contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine code for programmatic handling, when applicable.","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6e82e4ba-ede4-47de-9bb5-f51c70d65044":{"description":"A requested platform is unavailable, or an inherited scope has no available platforms (code PLATFORM_UNAVAILABLE; platforms lists affected ids). Update the requested scope before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","const":"PLATFORM_UNAVAILABLE","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"platforms":{"type":"array","items":{"type":"string","enum":["chatgpt","chatgpt_app","claude","gemini","gemini_app","grok_app","grok_api","perplexity","perplexity_app","google_app","deepseek"],"description":"LLM platform identifier. Newer scraper-backed ids end in `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy and not returned by current runs.","uniqueKey":"platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"platforms","typeLabel":"enum\u003cstring>[]"}},"required":["error","code","platforms"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"PLATFORM_UNAVAILABLE","platforms":["chatgpt"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3960d47c-0a09-42b0-9e70-2e12733ab090":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Clerk API key. Create one from your account settings under API Keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ebb5f2df-1467-4f50-9c9b-ef0c626f0ea4":{"url":"https://openlens.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Clerk API key. Create one from your account settings under API Keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Clerk API key. Create one from your account settings under API Keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"breadtechnologiesinc","siteName":"OpenLens","title":"Add a schedule to the project - OpenLens","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T09:00:28.662Z","originalFileLocation":"api-reference/resources/add-a-schedule-to-the-project.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=\"Builds a schedule from the project\u0026#x27;s defaults and the body. A project\u0026#x27;s second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenLens\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a schedule to the project - OpenLens\">\u003cmeta data-mint-head property=\"og:description\" content=\"Builds a schedule from the project\u0026#x27;s defaults and the body. A project\u0026#x27;s second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenLens\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breadtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=Add+a+schedule+to+the+project\u0026amp;description=Builds+a+schedule+from+the+project%27s+defaults+and+the+body.+A+project%27s+second+schedule+needs+a+plan+with+multiple+schedules+%28Agency%29%3B+otherwise+402+%60MULTIPLE_S\u0026amp;theme=5c9739b4ec94c7eb38f818e3\u0026amp;signature=84aa74bf62481371b1fdc040ffe95e7a335458427d30eb9e049aa8eff1d298f0\">\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=\"Add a schedule to the project - OpenLens\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Builds a schedule from the project\u0026#x27;s defaults and the body. A project\u0026#x27;s second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breadtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=Add+a+schedule+to+the+project\u0026amp;description=Builds+a+schedule+from+the+project%27s+defaults+and+the+body.+A+project%27s+second+schedule+needs+a+plan+with+multiple+schedules+%28Agency%29%3B+otherwise+402+%60MULTIPLE_S\u0026amp;theme=5c9739b4ec94c7eb38f818e3\u0026amp;signature=84aa74bf62481371b1fdc040ffe95e7a335458427d30eb9e049aa8eff1d298f0\">\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/breadtechnologiesinc/OV5VCFf7ENY_PFmu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenLens\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a6b54\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/resources/add-a-schedule-to-the-project.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openlens.com/#organization\",\"name\":\"OpenLens\",\"url\":\"https://docs.openlens.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openlens.com#website\",\"name\":\"OpenLens\",\"url\":\"https://docs.openlens.com\",\"publisher\":{\"@id\":\"https://docs.openlens.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project#webpage\",\"url\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project\",\"name\":\"Add a schedule to the project\",\"description\":\"Builds a schedule from the project's defaults and the body. A project's second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.\",\"dateModified\":\"2026-10-25T09:00:28.662Z\",\"isPartOf\":{\"@id\":\"https://docs.openlens.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.openlens.com/api-reference/resources/list-your-projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a schedule to the project\",\"item\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project#apireference\",\"headline\":\"Add a schedule to the project\",\"name\":\"Add a schedule to the project\",\"description\":\"Builds a schedule from the project's defaults and the body. A project's second schedule needs a plan with multiple schedules (Agency); otherwise 402 MULTIPLE_SCHEDULES_NOT_ALLOWED. A project can have up to 5 schedules, switched-off ones included; a sixth is refused with 400 SCHEDULE_LIMIT_REACHED. Answers with every schedule of the project.\",\"url\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openlens.com/api-reference/resources/add-a-schedule-to-the-project#webpage\"},\"dateModified\":\"2026-10-25T09:00:28.662Z\",\"publisher\":{\"@id\":\"https://docs.openlens.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openlens.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenLens\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpenLens","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Onboarding","pages":[{"title":"Analyze a brand or confirm a new project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboard","href":"/api-reference/onboarding/analyze-a-brand-or-confirm-a-new-project"}]},{"group":"Runs","pages":[{"title":"Start (or resume) a prompt run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /prompts/run","href":"/api-reference/runs/start-or-resume-a-prompt-run"},{"title":"Cancel the running run for a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /prompts/run","href":"/api-reference/runs/cancel-the-running-run-for-a-project"},{"title":"Poll the status of a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /prompts/status","href":"/api-reference/runs/poll-the-status-of-a-run"},{"title":"List a project's prompt run history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /prompts/runs","href":"/api-reference/runs/list-a-projects-prompt-run-history"},{"title":"Raw platform responses from the latest usable or selected run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /prompts/results","href":"/api-reference/runs/raw-platform-responses-from-the-latest-usable-or-selected-run"}]},{"group":"Metrics","pages":[{"title":"Visibility scores for the latest usable or selected run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /visibility","href":"/api-reference/metrics/visibility-scores-for-the-latest-usable-or-selected-run"},{"title":"Time-series visibility for a brand or all competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /visibility/trends","href":"/api-reference/metrics/time-series-visibility-for-a-brand-or-all-competitors"},{"title":"Per-platform source behavior patterns for the latest or selected run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /insights/engines","href":"/api-reference/metrics/per-platform-source-behavior-patterns-for-the-latest-or-selected-run"},{"title":"AI-generated insight paragraph for one topic and run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /insights/topic","href":"/api-reference/metrics/ai-generated-insight-paragraph-for-one-topic-and-run"}]},{"group":"Citations","pages":[{"title":"Top topics where your own brand was mentioned, with the URLs cited","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brand-mentions-summary","href":"/api-reference/citations/top-topics-where-your-own-brand-was-mentioned-with-the-urls-cited"},{"title":"Top cited domains for the latest or selected run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sources","href":"/api-reference/citations/top-cited-domains-for-the-latest-or-selected-run"}]},{"group":"Deliverables","pages":[{"title":"Download a client-ready PDF visibility report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reports/visibility","href":"/api-reference/deliverables/download-a-client-ready-pdf-visibility-report"},{"title":"Recent run history for the report picker","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reports/runs","href":"/api-reference/deliverables/recent-run-history-for-the-report-picker"}]},{"group":"Resources","pages":[{"title":"List your projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects","href":"/api-reference/resources/list-your-projects"},{"title":"Create a new project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects","href":"/api-reference/resources/create-a-new-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /projects/{id}","href":"/api-reference/resources/update-a-project"},{"title":"Archive a project (soft delete)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /projects/{id}","href":"/api-reference/resources/archive-a-project-soft-delete"},{"title":"Get the project's active platforms and the caller's entitlement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}/platforms","href":"/api-reference/resources/get-the-projects-active-platforms-and-the-callers-entitlement"},{"title":"Set the project's active platforms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /projects/{id}/platforms","href":"/api-reference/resources/set-the-projects-active-platforms"},{"title":"Get the project's schedule at a glance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}/schedule","href":"/api-reference/resources/get-the-projects-schedule-at-a-glance"},{"title":"Create or update the project's primary schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /projects/{id}/schedule","href":"/api-reference/resources/create-or-update-the-projects-primary-schedule"},{"title":"List the project's schedules","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}/schedules","href":"/api-reference/resources/list-the-projects-schedules"},{"title":"Add a schedule to the project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects/{id}/schedules","href":"/api-reference/resources/add-a-schedule-to-the-project"},{"title":"Delete one of the project's schedules","description":"Its past runs and their results stay. Answers with the project's remaining schedules.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /projects/{id}/schedules/{scheduleId}","href":"/api-reference/resources/delete-one-of-the-projects-schedules"},{"title":"Update one of the project's schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /projects/{id}/schedules/{scheduleId}","href":"/api-reference/resources/update-one-of-the-projects-schedules"},{"title":"List allowed prompt-attribute values for the project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}/prompt-attributes","href":"/api-reference/resources/list-allowed-prompt-attribute-values-for-the-project"},{"title":"Add a custom prompt-attribute value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects/{id}/prompt-attributes","href":"/api-reference/resources/add-a-custom-prompt-attribute-value"},{"title":"Archive a custom prompt-attribute by value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /projects/{id}/prompt-attributes","href":"/api-reference/resources/archive-a-custom-prompt-attribute-by-value"},{"title":"Rename or archive an existing custom prompt-attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /projects/{id}/prompt-attributes","href":"/api-reference/resources/rename-or-archive-an-existing-custom-prompt-attribute"},{"title":"List brands in a project (your own + competitors)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands","href":"/api-reference/resources/list-brands-in-a-project-your-own-+-competitors"},{"title":"Add a brand (competitor or own)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands","href":"/api-reference/resources/add-a-brand-competitor-or-own"},{"title":"Delete a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands","href":"/api-reference/resources/delete-a-brand"},{"title":"Update a brand's aliases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /brands","href":"/api-reference/resources/update-a-brands-aliases"},{"title":"List topics in a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /topics","href":"/api-reference/resources/list-topics-in-a-project"},{"title":"Create a topic; prompts are generated in the background","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /topics","href":"/api-reference/resources/create-a-topic;-prompts-are-generated-in-the-background"},{"title":"Delete a topic and its prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /topics","href":"/api-reference/resources/delete-a-topic-and-its-prompts"},{"title":"List prompts, optionally filtered by topic or fetched by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /prompts","href":"/api-reference/resources/list-prompts-optionally-filtered-by-topic-or-fetched-by-id"},{"title":"Update prompt text, attributes, or active flag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /prompts","href":"/api-reference/resources/update-prompt-text-attributes-or-active-flag"},{"title":"Create a prompt under a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /prompts","href":"/api-reference/resources/create-a-prompt-under-a-topic"},{"title":"Soft-delete a prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /prompts","href":"/api-reference/resources/soft-delete-a-prompt"}]},{"group":"Account","pages":[{"title":"Return the caller's effective rate limits and quotas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /me/limits","href":"/api-reference/account/return-the-callers-effective-rate-limits-and-quotas"},{"title":"Token usage and scraper spend, aggregated by model and call type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage","href":"/api-reference/account/token-usage-and-scraper-spend-aggregated-by-model-and-call-type"},{"title":"Deprecated: schedule lives on the project (410 Gone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /settings/schedule","href":"/api-reference/account/deprecated:-schedule-lives-on-the-project-410-gone"},{"title":"List the caller's allowed platforms (read-only entitlement)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /settings/platforms","href":"/api-reference/account/list-the-callers-allowed-platforms-read-only-entitlement"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"title":"Add a schedule to the project - OpenLens","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}