A POST to the /currencies/batch.json endpoint allows your application to record the
market rate for many currency pairs in one call, as the service that follows the market
does once a day.
Only pairs the tenant already holds are written. A pair it does not hold is returned
under skipped rather than created: which pairs a tenant prices is a decision it makes,
and a feed should not be able to widen that by sending a rate for something new.
The rates are recorded, not applied. A currency goes on converting by whatever it
converted by before, until it is separately set to use its market rate.
The trading day every rate in this call is the rate for, given as
YYYY-MM-DD. One day for the whole call rather than one per pair: a set of
rates read off the market together belongs to the same day, and letting
them disagree would leave no day the set as a whole could be said to be for.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Omneo API","colors":{"primary":"#FF6161","light":"#FF6161","dark":"#E04444"},"logo":{"light":"https://mintcdn.com/omneo/fFdVHCWce-qgKJ08/logo/light.svg?fit=max\u0026auto=format\u0026n=fFdVHCWce-qgKJ08\u0026q=85\u0026s=c68e59d64ae77bf2ac88c191b875b014","dark":"https://mintcdn.com/omneo/fFdVHCWce-qgKJ08/logo/dark.svg?fit=max\u0026auto=format\u0026n=fFdVHCWce-qgKJ08\u0026q=85\u0026s=800651cbcf5d77a7b130ae6928a7c590"},"favicon":"https://mintcdn.com/omneo/fFdVHCWce-qgKJ08/favicon.svg?fit=max\u0026auto=format\u0026n=fFdVHCWce-qgKJ08\u0026q=85\u0026s=7ccd4454f7329addccfd399fcdff7d7c","navbar":{"links":[{"href":"mailto:support@omneo.io","label":"Support"}],"primary":{"type":"button","label":"Get started","href":"https://docs.omneo.io/getting-started/what-is-omneo"}},"footer":{"socials":{"github":"https://github.com/omneo","linkedin":"https://linkedin.com/company/omneocx"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://omneo.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omneo","hasAudioNarration":false,"actualSubdomain":"omneo","customDomains":["docs.omneo.io"],"gitSource":{"type":"github","owner":"omneo","repo":"omneo-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adee21e57ec93adba543ce1","collectionId":"f57e716c-ef88-49b4-8ae5-d9dae98c14e2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adee21e57ec93adba543ce1"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adee21e57ec93adba543ce1","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":688},{"language":"default","tag":"Commerce","count":167},{"language":"default","tag":"Incentives","count":142},{"language":"default","tag":"Profiles","count":98},{"language":"default","tag":"Extensions","count":82},{"language":"default","tag":"Developers","count":78},{"language":"default","tag":"Configuration","count":73},{"language":"default","tag":"Concepts","count":62},{"language":"default","tag":"Reactions","count":54},{"language":"default","tag":"Platform","count":47}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@omneo.io"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/currency/add-market-rates","slug":"/api-reference/currency/add-market-rates","pageMetadata":{"openapi":"post /v3/currencies/batch.json","title":"Add Market Rates","description":"A `POST` to the `/currencies/batch.json` endpoint allows your application to record the\nmarket rate for many currency pairs in one call, as the service that follows the market\ndoes once a day.\n\nOnly pairs the tenant already holds are written. A pair it does not hold is returned\nunder `skipped` rather than created: which pairs a tenant prices is a decision it makes,\nand a feed should not be able to widen that by sending a rate for something new.\n\nThe rates are recorded, not applied. A currency goes on converting by whatever it\nconverted by before, until it is separately set to use its market rate.","href":"/api-reference/currency/add-market-rates"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"POST\"\n }), \" to the \", _jsx(_components.code, {\n children: \"/currencies/batch.json\"\n }), \" endpoint allows your application to record the\\nmarket rate for many currency pairs in one call, as the service that follows the market\\ndoes once a day.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Only pairs the tenant already holds are written. A pair it does not hold is returned\\nunder \", _jsx(_components.code, {\n children: \"skipped\"\n }), \" rather than created: which pairs a tenant prices is a decision it makes,\\nand a feed should not be able to widen that by sending a rate for something new.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The rates are recorded, not applied. A currency goes on converting by whatever it\\nconverted by before, until it is separately set to use its market rate.\"\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":{"openapi":"post /v3/currencies/batch.json","title":"Add Market Rates","description":"A `POST` to the `/currencies/batch.json` endpoint allows your application to record the\nmarket rate for many currency pairs in one call, as the service that follows the market\ndoes once a day.\n\nOnly pairs the tenant already holds are written. A pair it does not hold is returned\nunder `skipped` rather than created: which pairs a tenant prices is a decision it makes,\nand a feed should not be able to widen that by sending a rate for something new.\n\nThe rates are recorded, not applied. A currency goes on converting by whatever it\nconverted by before, until it is separately set to use its market rate.","href":"/api-reference/currency/add-market-rates"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"currency.batchJson","description":"A `POST` to the `/currencies/batch.json` endpoint allows your application to record the\nmarket rate for many currency pairs in one call, as the service that follows the market\ndoes once a day.\n\nOnly pairs the tenant already holds are written. A pair it does not hold is returned\nunder `skipped` rather than created: which pairs a tenant prices is a decision it makes,\nand a feed should not be able to widen that by sending a rate for something new.\n\nThe rates are recorded, not applied. A currency goes on converting by whatever it\nconverted by before, until it is separately set to use its market rate.","summary":"Add Market Rates","tags":["Currency"],"requestBody":"e6e5d117-a854-4286-a1e5-a15dfde2836e","responses":{"200":"9342d352-51f6-4eac-bc56-71ca4f382181","401":"cda0cb06-8eac-47de-847f-ab87c9ed1b94","403":"b0cf5c1b-0809-4fba-9bd9-dc73433f17e0","422":"ec7686e9-3e18-4309-8ef1-e124f260435a"},"method":"post","type":"path","servers":["01931fa0-33dc-43b7-8713-75208860b4aa"],"security":[],"path":"/v3/currencies/batch.json","baseUrlOptions":["https://api.{tenant}.getomneo.com/api"],"title":"Add Market Rates","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"market_rate_date":{"type":"string","format":"date","description":"The trading day every rate in this call is the rate for, given as\n`YYYY-MM-DD`. One day for the whole call rather than one per pair: a set of\nrates read off the market together belongs to the same day, and letting\nthem disagree would leave no day the set as a whole could be said to be for.","isRequired":true,"uniqueKey":"market_rate_date","typeLabel":"string\u003cdate>"},"currencies":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currencies.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currencies.items.[INDEX].to","typeLabel":"string"},"market_rate":{"type":"number","isRequired":true,"uniqueKey":"currencies.items.[INDEX].market_rate","typeLabel":"number"}},"required":["from","to","market_rate"],"uniqueKey":"currencies.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":500,"isRequired":true,"uniqueKey":"currencies","typeLabel":"object[]"}},"required":["market_rate_date","currencies"],"title":"BatchCurrencyJson","uniqueKey":"","typeLabel":"BatchCurrencyJson · object"},"examples":{"Example":{"title":"Example","value":{"market_rate_date":"2023-12-25","currencies":[{"from":"\u003cstring>","to":"\u003cstring>","market_rate":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9342d352-51f6-4eac-bc56-71ca4f382181":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"market_rate_date":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"market_rate_date","typeLabel":"any"},"updated":{"type":"integer","isRequired":true,"uniqueKey":"updated","typeLabel":"integer"},"skipped":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"skipped.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"skipped.items.[INDEX].to","typeLabel":"string"}},"required":["from","to"],"uniqueKey":"skipped.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"skipped","typeLabel":"object[]"}},"required":["market_rate_date","updated","skipped"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"market_rate_date":"\u003cunknown>","updated":123,"skipped":[{"from":"\u003cstring>","to":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cda0cb06-8eac-47de-847f-ab87c9ed1b94":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b0cf5c1b-0809-4fba-9bd9-dc73433f17e0":{"description":"Authorization error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ec7686e9-3e18-4309-8ef1-e124f260435a":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"01931fa0-33dc-43b7-8713-75208860b4aa":{"url":"https://api.{tenant}.getomneo.com/api","variables":{"tenant":{"default":"example"}}}}},"originalFileLocation":"api-reference/api.json"},"subdomain":"omneo","siteName":"Omneo API","title":"Add Market Rates - Omneo API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T04:47:18.613Z","originalFileLocation":"api-reference/currency/add-market-rates.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=\"A POST to the /currencies/batch.json endpoint allows your application to record the market rate for many currency pairs in one call, as the service that follows the market does once a day. Only pairs the tenant already holds are written. A pair it does not hold is returned under skipped rather than created: which pairs a tenant prices is a decision it makes, and a feed should not be able to widen that by sending a rate for something new. The rates are recorded, not applied. A currency goes on converting by whatever it converted by before, until it is separately set to use its market rate.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Omneo API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_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/omneo/svRkUa8yAUbXSnpa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add Market Rates - Omneo API\">\u003cmeta data-mint-head property=\"og:description\" content=\"A POST to the /currencies/batch.json endpoint allows your application to record the market rate for many currency pairs in one call, as the service that follows the market does once a day. Only pairs the tenant already holds are written. A pair it does not hold is returned under skipped rather than created: which pairs a tenant prices is a decision it makes, and a feed should not be able to widen that by sending a rate for something new. The rates are recorded, not applied. A currency goes on converting by whatever it converted by before, until it is separately set to use its market rate.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Omneo API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.omneo.io/api-reference/currency/add-market-rates\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omneo.mintlify.app/_mintlify/api/og/v2?division=Currency\u0026amp;title=Add+Market+Rates\u0026amp;description=A+%60POST%60+to+the+%60%2Fcurrencies%2Fbatch.json%60+endpoint+allows+your+application+to+record+the%0Amarket+rate+for+many+currency+pairs+in+one+call%2C+as+the+service+that+fol\u0026amp;theme=a4af636e3b43b19a06e39d49\u0026amp;signature=1e222db823f99e02f1fc0b0595dee60525558f2c7fe7288e9dab59947511be03\">\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 Market Rates - Omneo API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A POST to the /currencies/batch.json endpoint allows your application to record the market rate for many currency pairs in one call, as the service that follows the market does once a day. Only pairs the tenant already holds are written. A pair it does not hold is returned under skipped rather than created: which pairs a tenant prices is a decision it makes, and a feed should not be able to widen that by sending a rate for something new. The rates are recorded, not applied. A currency goes on converting by whatever it converted by before, until it is separately set to use its market rate.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omneo.mintlify.app/_mintlify/api/og/v2?division=Currency\u0026amp;title=Add+Market+Rates\u0026amp;description=A+%60POST%60+to+the+%60%2Fcurrencies%2Fbatch.json%60+endpoint+allows+your+application+to+record+the%0Amarket+rate+for+many+currency+pairs+in+one+call%2C+as+the+service+that+fol\u0026amp;theme=a4af636e3b43b19a06e39d49\u0026amp;signature=1e222db823f99e02f1fc0b0595dee60525558f2c7fe7288e9dab59947511be03\">\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/omneo/svRkUa8yAUbXSnpa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Omneo API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6161\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.omneo.io/api-reference/currency/add-market-rates\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/currency/add-market-rates.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.omneo.io/#organization\",\"name\":\"Omneo API\",\"url\":\"https://docs.omneo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/omneo/fFdVHCWce-qgKJ08/logo/light.svg?fit=max\u0026auto=format\u0026n=fFdVHCWce-qgKJ08\u0026q=85\u0026s=c68e59d64ae77bf2ac88c191b875b014\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.omneo.io#website\",\"name\":\"Omneo API\",\"url\":\"https://docs.omneo.io\",\"publisher\":{\"@id\":\"https://docs.omneo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.omneo.io/api-reference/currency/add-market-rates#webpage\",\"url\":\"https://docs.omneo.io/api-reference/currency/add-market-rates\",\"name\":\"Add Market Rates\",\"description\":\"A POST to the /currencies/batch.json endpoint allows your application to record the market rate for many currency pairs in one call, as the service that follows the market does once a day. Only pairs the tenant already holds are written. A pair it does not hold is returned under skipped rather than created: which pairs a tenant prices is a decision it makes, and a feed should not be able to widen that by sending a rate for something new. The rates are recorded, not applied. A currency goes on converting by whatever it converted by before, until it is separately set to use its market rate.\",\"dateModified\":\"2026-10-07T04:47:18.613Z\",\"isPartOf\":{\"@id\":\"https://docs.omneo.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omneo.io/api-reference/currency/add-market-rates#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omneo.io/api-reference/currency/add-market-rates#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Configuration\",\"item\":\"https://docs.omneo.io/api-reference/connection/browse-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Currency\",\"item\":\"https://docs.omneo.io/api-reference/currency/browse-currencies\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add Market Rates\",\"item\":\"https://docs.omneo.io/api-reference/currency/add-market-rates\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.omneo.io/api-reference/currency/add-market-rates#apireference\",\"headline\":\"Add Market Rates\",\"name\":\"Add Market Rates\",\"description\":\"A POST to the /currencies/batch.json endpoint allows your application to record the market rate for many currency pairs in one call, as the service that follows the market does once a day. Only pairs the tenant already holds are written. A pair it does not hold is returned under skipped rather than created: which pairs a tenant prices is a decision it makes, and a feed should not be able to widen that by sending a rate for something new. The rates are recorded, not applied. A currency goes on converting by whatever it converted by before, until it is separately set to use its market rate.\",\"url\":\"https://docs.omneo.io/api-reference/currency/add-market-rates\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omneo.io/api-reference/currency/add-market-rates#webpage\"},\"dateModified\":\"2026-10-07T04:47:18.613Z\",\"publisher\":{\"@id\":\"https://docs.omneo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.omneo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Omneo API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Omneo API","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://omneo.io"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/what-is-omneo"}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts/glossary"}]},{"tab":"User Guides","pages":[{"title":"User Guides","href":"/business-guides/managing-your-instance/is-omneo-right"}]},{"tab":"Experiences","pages":[{"title":"Experiences","href":"/experiences/omneo-insights/overview"}]},{"tab":"Extensions","pages":[{"title":"Extensions","href":"/extensions/overview"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/dev-guides/core-setup/authentication"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Omneo API Reference","href":"/api-reference/introduction"},{"title":"API changelog","href":"/api-reference/changelog"}]},{"group":"Authentication","pages":[{"group":"OAuth","pages":[{"openapi":"post /v3/auth/token","title":"Issue OAuth Access Token","href":"/api-reference/access-token/authorize-a-client-to-access-the-users-account"},{"openapi":"get /v3/auth/authorize","title":"Authorize OAuth Client","href":"/api-reference/authorization/authorize-a-client-to-access-the-users-account"},{"openapi":"get /v3/auth/personal-access-tokens","title":"Invoke the controller method","href":"/api-reference/redirect/invoke-the-controller-method"},{"openapi":"get /v3/auth/personal-access-tokens/{token_id}","title":"Invoke the controller method","href":"/api-reference/redirect/invoke-the-controller-method-1"},{"openapi":"post /v3/auth/token","title":"Issue OAuth Access Token","href":"/api-reference/o-auth-access-token/issue-oauth-access-token"},{"openapi":"get /v3/auth/authorize","title":"Authorize OAuth Client","href":"/api-reference/o-auth-authorization/authorize-oauth-client"}]},{"group":"Personal Access Tokens","pages":[{"openapi":"get /v3/auth/api-tokens","title":"Get all of the personal access tokens for the authenticated user","href":"/api-reference/personal-access-token/get-all-of-the-personal-access-tokens-for-the-authenticated-user"},{"openapi":"post /v3/auth/api-tokens","title":"Create a new personal access token for the user","href":"/api-reference/personal-access-token/create-a-new-personal-access-token-for-the-user"},{"openapi":"post /v3/auth/personal-access-tokens","title":"Create a new personal access token for the user","href":"/api-reference/personal-access-token/create-a-new-personal-access-token-for-the-user-1"},{"openapi":"delete /v3/auth/personal-access-tokens/{tokenId}","title":"Delete the given token","href":"/api-reference/personal-access-token/delete-the-given-token"},{"openapi":"delete /v3/auth/personal-access-tokens/{tokenId}","title":"Delete the given token","href":"/api-reference/personal-access-token/delete-the-given-token-1"},{"openapi":"delete /v3/auth/api-tokens/{token}","title":"Delete Personal Access Token","href":"/api-reference/oauth-access-token/delete-personal-access-token"}]},{"group":"Authorized Tokens","pages":[{"openapi":"get /v3/auth/tokens","title":"Get all of the authorized tokens for the authenticated user","href":"/api-reference/authorized-access-token/get-all-of-the-authorized-tokens-for-the-authenticated-user"},{"openapi":"delete /v3/auth/tokens/{tokenId}","title":"Delete the given token","href":"/api-reference/authorized-access-token/delete-the-given-token"}]},{"group":"Transient Token","pages":[{"openapi":"post /v3/auth/token/refresh","title":"Get a fresh transient token cookie for the authenticated user","href":"/api-reference/transient-token/get-a-fresh-transient-token-cookie-for-the-authenticated-user"}]},{"group":"Scopes","pages":[{"openapi":"get /v3/auth/scopes","title":"Get all of the available scopes for the application","href":"/api-reference/scope/get-all-of-the-available-scopes-for-the-application"}]},{"group":"Client","pages":[{"openapi":"delete /v3/auth/clients/{clientId}","title":"Delete the given client","href":"/api-reference/client/delete-the-given-client"}]}]},{"group":"Profiles","pages":[{"group":"Profile","pages":[{"title":"Profiles","href":"/api-reference/profile/overview"},{"openapi":"post /v3/profiles/availability","title":"Check Availability","href":"/api-reference/profile/check-availability"},{"openapi":"get /v3/profiles","title":"Browse Profiles","href":"/api-reference/profile/browse-profiles"},{"openapi":"post /v3/profiles","title":"Add Profile","href":"/api-reference/profile/add-profile"},{"openapi":"get /v3/profiles/{profile}","title":"Read Profile","href":"/api-reference/profile/read-profile"},{"openapi":"put /v3/profiles/{profile}","title":"Edit Profile","href":"/api-reference/profile/edit-profile"},{"openapi":"delete /v3/profiles/{profile}","title":"Delete Profile","href":"/api-reference/profile/delete-profile"},{"openapi":"post /v3/profiles/search-id","title":"Get Profile By Id or Identity","href":"/api-reference/profile/get-profile-by-id-or-identity"},{"openapi":"post /v3/profiles/exists","title":"Check Profile Existence","href":"/api-reference/profile/check-profile-existence"},{"openapi":"post /v3/profiles/merge","title":"Merge Profiles","href":"/api-reference/profile/merge-profiles"},{"openapi":"post /v3/profiles/sync","title":"Sync Profiles","href":"/api-reference/profile/sync-profiles"},{"openapi":"post /v3/profiles/batch","title":"Batch Profiles","href":"/api-reference/profile/batch-profiles"},{"openapi":"get /v3/profiles/{profile}/resync","title":"Resync Profile","href":"/api-reference/profile/resync-profile"},{"openapi":"delete /v3/profiles/{profile}/purge","title":"Purge Profile","href":"/api-reference/profile/purge-profile"},{"openapi":"put /v3/profiles/{profile}/update-type","title":"Update Profile Type","href":"/api-reference/profile/update-profile-type"},{"openapi":"put /v3/profiles/{profile}/public","title":"Edit Profile Public Status","href":"/api-reference/profile/edit-profile-public-status"},{"openapi":"post /v3/profiles/{profile}/custom-event","title":"Trigger Profile Custom Event","href":"/api-reference/profile/trigger-profile-custom-event"},{"openapi":"post /v3/profiles/batch.json","title":"Batch Profiles","href":"/api-reference/profile/batch-profiles-1"}]},{"group":"Profile Identity","pages":[{"title":"Profile Identities","href":"/api-reference/profile-identity/overview"},{"openapi":"get /v3/profiles/{profile}/identities","title":"Read Profile's Identities","href":"/api-reference/profile-identity/read-profiles-identities"},{"openapi":"post /v3/profiles/{profile}/identities","title":"Add Profile Identity","href":"/api-reference/profile-identity/add-profile-identity"},{"openapi":"get /v3/profiles/{profile}/identities/{handle}","title":"Read Profile Identity","href":"/api-reference/profile-identity/read-profile-identity"},{"openapi":"put /v3/profiles/{profile}/identities/{handle}","title":"Edit Profile Identity","href":"/api-reference/profile-identity/edit-profile-identity"},{"openapi":"delete /v3/profiles/{profile}/identities/{handle}","title":"Delete Profile Identity","href":"/api-reference/profile-identity/delete-profile-identity"},{"openapi":"get /v3/profiles/{profile}/identities/id/{identity}","title":"Read Profile Identity by ID","href":"/api-reference/profile-identity/read-profile-identity-by-id"},{"openapi":"put /v3/profiles/{profile}/identities/id/{identity}","title":"Edit Profile Identity by ID","href":"/api-reference/profile-identity/edit-profile-identity-by-id"},{"openapi":"delete /v3/profiles/{profile}/identities/id/{identity}","title":"Delete Profile Identity by ID","href":"/api-reference/profile-identity/delete-profile-identity-by-id"}]},{"group":"Identity Search","pages":[{"openapi":"get /v3/identities","title":"Browse Profile Identities","href":"/api-reference/identity/browse-profile-identities"},{"openapi":"get /v3/identities/search-profile/{identifier}","title":"Search Profiles by Identity","href":"/api-reference/identity/search-profiles-by-identity"},{"openapi":"get /v3/identities/handles","title":"Browse Unique Identity Handles","href":"/api-reference/identity/browse-unique-identity-handles"}]},{"group":"Profile Address","pages":[{"title":"Profile Addresses","href":"/api-reference/profile-address/overview"},{"openapi":"get /v3/profiles/{profile}/addresses","title":"Browse Profile Addresses","href":"/api-reference/profile-address/browse-profile-addresses"},{"openapi":"post /v3/profiles/{profile}/addresses","title":"Add Profile Address","href":"/api-reference/profile-address/add-profile-address"},{"openapi":"get /v3/profiles/{profile}/addresses/{address}","title":"Read Profile Address","href":"/api-reference/profile-address/read-profile-address"},{"openapi":"put /v3/profiles/{profile}/addresses/{address}","title":"Edit Profile Address","href":"/api-reference/profile-address/edit-profile-address"},{"openapi":"delete /v3/profiles/{profile}/addresses/{address}","title":"Delete Profile Address","href":"/api-reference/profile-address/delete-profile-address"},{"openapi":"post /v3/profiles/{profile}/addresses/upsert","title":"Add or Update Profile Address","href":"/api-reference/profile-address/add-or-update-profile-address"}]},{"group":"Profile Aggregation","pages":[{"title":"Aggregations","href":"/api-reference/profile-aggregation/overview"},{"openapi":"get /v3/profiles/{profile}/aggregations","title":"Read Aggregations","href":"/api-reference/profile-aggregation/read-aggregations"},{"openapi":"put /v3/profiles/{profile}/aggregations","title":"Edit Profile Aggregation","href":"/api-reference/profile-aggregation/edit-profile-aggregation"},{"openapi":"get /v3/profiles/{profile}/aggregations/calculate","title":"Calculate Profile Aggregations","href":"/api-reference/profile-aggregation/calculate-profile-aggregations"},{"openapi":"post /v3/profile/aggregations/batch.json","title":"Batch Profile Aggregations","href":"/api-reference/profile-aggregation/batch-profile-aggregations"}]},{"group":"Profile Appearance Attribute","pages":[{"title":"Profile Attributes (Appearance)","href":"/api-reference/profile-appearance-attribute/overview"},{"openapi":"get /v3/profiles/{profile}/attributes/appearance","title":"Read Profile Attributes (Appearance)","href":"/api-reference/profile-appearance-attribute/read-profile-attributes-appearance"},{"openapi":"put /v3/profiles/{profile}/attributes/appearance","title":"Edit Profile Attributes (Appearance)","href":"/api-reference/profile-appearance-attribute/edit-profile-attributes-appearance"}]},{"group":"Profile Comms Attribute","pages":[{"title":"Profile Attributes (Comms)","href":"/api-reference/profile-comms-attribute/overview"},{"openapi":"get /v3/profiles/{profile}/attributes/comms","title":"Read Profile Attributes (Comms)","href":"/api-reference/profile-comms-attribute/read-profile-attributes-comms"},{"openapi":"put /v3/profiles/{profile}/attributes/comms","title":"Edit Profile Attributes (Comms)","href":"/api-reference/profile-comms-attribute/edit-profile-attributes-comms"}]},{"group":"Profile Custom Attribute","pages":[{"openapi":"get /v3/profiles/{profile}/attributes/custom","title":"Read Profile Attributes (Custom)","href":"/api-reference/profile-custom-attribute/read-profile-attributes-custom"},{"openapi":"get /v3/profiles/{profile}/attributes/custom/{identifier}","title":"Read Profile Custom Attribute","href":"/api-reference/profile-custom-attribute/read-profile-custom-attribute"},{"openapi":"put /v3/profiles/{profile}/attributes/custom/{identifier}","title":"Edit Profile Custom Attribute","href":"/api-reference/profile-custom-attribute/edit-profile-custom-attribute"},{"openapi":"delete /v3/profiles/{profile}/attributes/custom/{identifier}","title":"Delete Profile Custom Attribute","href":"/api-reference/profile-custom-attribute/delete-profile-custom-attribute"},{"openapi":"get /v3/profiles/attributes/custom","title":"Search Profiles by Custom Attributes","href":"/api-reference/profile-custom-attribute/search-profiles-by-custom-attributes"},{"openapi":"post /v3/profile/custom-attributes/batch.json","title":"Batch Profile Custom Attributes","href":"/api-reference/profile-custom-attribute/batch-profile-custom-attributes"}]},{"group":"Profile Dates Attribute","pages":[{"openapi":"get /v3/profiles/{profile}/attributes/dates","title":"Read Profile Attributes (Dates)","href":"/api-reference/profile-dates-attribute/read-profile-attributes-dates"},{"openapi":"put /v3/profiles/{profile}/attributes/dates","title":"Edit Profile Attributes (Dates)","href":"/api-reference/profile-dates-attribute/edit-profile-attributes-dates"},{"openapi":"delete /v3/profiles/{profile}/attributes/dates/{datesAttribute}","title":"Delete Profile Date Attribute","href":"/api-reference/profile-dates-attribute/delete-profile-date-attribute"},{"openapi":"post /v3/profiles/{profile}/attributes/dates","title":"Create Profile Attribute (Dates)","href":"/api-reference/profile-dates-attribute/create-profile-attribute-dates"}]},{"group":"Profile Connection","pages":[{"openapi":"get /v3/profiles/{profile}/connections","title":"Read Profile Connections","href":"/api-reference/profile-connection/read-profile-connections"},{"openapi":"put /v3/profiles/{profile}/connections/{connection}","title":"Edit Profile Connection","href":"/api-reference/profile-connection/edit-profile-connection"},{"openapi":"get /v3/profiles/{profile}/connections/{connection}/profileInfo","title":"Read Connected Profile Data","href":"/api-reference/profile-connection/read-connected-profile-data"}]},{"group":"Profile Validation Rule","pages":[{"openapi":"get /v3/profiles/validation-rules","title":"Browse Profile Validation Rules","href":"/api-reference/profile-validation-rule/browse-profile-validation-rules"},{"openapi":"post /v3/profiles/validation-rules","title":"Create Profile Validation Rule","href":"/api-reference/profile-validation-rule/create-profile-validation-rule"},{"openapi":"get /v3/profiles/validation-rules/{profileValidationRule}","title":"Read Profile Validation Rule","href":"/api-reference/profile-validation-rule/read-profile-validation-rule"},{"openapi":"put /v3/profiles/validation-rules/{profileValidationRule}","title":"Update Profile Validation Rule","href":"/api-reference/profile-validation-rule/update-profile-validation-rule"},{"openapi":"delete /v3/profiles/validation-rules/{profileValidationRule}","title":"Delete Profile Validation Rule","href":"/api-reference/profile-validation-rule/delete-profile-validation-rule"}]},{"group":"Profile Validation Rule Value","pages":[{"openapi":"get /v3/profiles/validation-rules/{profileValidationRule}/values","title":"Browse Profile Validation Rule Values","href":"/api-reference/profile-validation-rule-value/browse-profile-validation-rule-values"},{"openapi":"post /v3/profiles/validation-rules/{profileValidationRule}/values","title":"Create Profile Validation Rule Value","href":"/api-reference/profile-validation-rule-value/create-profile-validation-rule-value"},{"openapi":"get /v3/profiles/validation-rules/{profileValidationRule}/values/{value}","title":"Read Profile Validation Rule Value","href":"/api-reference/profile-validation-rule-value/read-profile-validation-rule-value"},{"openapi":"put /v3/profiles/validation-rules/{profileValidationRule}/values/{value}","title":"Update Profile Validation Rule Value","href":"/api-reference/profile-validation-rule-value/update-profile-validation-rule-value"},{"openapi":"delete /v3/profiles/validation-rules/{profileValidationRule}/values/{value}","title":"Delete Profile Validation Rule Value","href":"/api-reference/profile-validation-rule-value/delete-profile-validation-rule-value"}]},{"group":"Profile Status","pages":[{"title":"Profile Status","href":"/api-reference/profile-status/overview"},{"openapi":"post /v3/profile/status/batch.json","title":"Batch Update Profile Statuses","href":"/api-reference/profile-status/batch-update-profile-statuses"},{"openapi":"delete /v3/profile/status/batch.json","title":"Batch Delete Profile Statuses","href":"/api-reference/profile-status/batch-delete-profile-statuses"}]},{"group":"Profile Tag","pages":[{"openapi":"post /v3/profile/tags/batch.json","title":"Batch Update Profile Tags","href":"/api-reference/profile-tag/batch-update-profile-tags"},{"openapi":"delete /v3/profile/tags/batch.json","title":"Batch Delete Profile Tags","href":"/api-reference/profile-tag/batch-delete-profile-tags"}]},{"group":"Profile Region","pages":[{"openapi":"get /v3/profiles/{profile}/regions","title":"Browse Profile Regions","href":"/api-reference/profile-region/browse-profile-regions"},{"openapi":"post /v3/profiles/{profile}/regions","title":"Add Profile Region","href":"/api-reference/profile-region/add-profile-region"},{"openapi":"put /v3/profiles/{profile}/regions/{region}","title":"Edit Profile Region","href":"/api-reference/profile-region/edit-profile-region"},{"openapi":"delete /v3/profiles/{profile}/regions/{regionId}","title":"Delete Profile Region","href":"/api-reference/profile-region/delete-profile-region"},{"openapi":"post /v3/profile/regions/batch.json","title":"Batch Profile Regions","href":"/api-reference/profile-region/batch-profile-regions"},{"openapi":"get /v3/profiles/{profile}/regions/{region}/switch-preview","title":"Preview Profile Region Switch","href":"/api-reference/profile-region/preview-profile-region-switch"},{"openapi":"post /v3/profiles/{profile}/regions/{region}/switch","title":"Switch Profile Region","href":"/api-reference/profile-region/switch-profile-region"}]},{"group":"Profile Balance","pages":[{"title":"Balances","href":"/api-reference/profile-balance/overview"},{"openapi":"get /v3/profiles/{profile}/balances","title":"Read Profile Balances","href":"/api-reference/profile-balance/read-profile-balances"}]}]},{"group":"Commerce","pages":[{"group":"Transaction","pages":[{"title":"Transactions","href":"/api-reference/transaction/overview"},{"openapi":"get /v3/transactions","title":"Browse Transactions","href":"/api-reference/transaction/browse-transactions"},{"openapi":"post /v3/transactions","title":"Add Transaction","href":"/api-reference/transaction/add-transaction"},{"openapi":"get /v3/transactions/{transaction}","title":"Read Transaction","href":"/api-reference/transaction/read-transaction"},{"openapi":"put /v3/transactions/{transaction}","title":"Edit Transaction","href":"/api-reference/transaction/edit-transaction"},{"openapi":"delete /v3/transactions/{transaction}","title":"Delete Transaction","href":"/api-reference/transaction/delete-transaction"},{"openapi":"post /v3/transactions/update-create","title":"Create or Update a Transaction","href":"/api-reference/transaction/create-or-update-a-transaction"},{"openapi":"get /v3/transactions/external/{id}","title":"Read Transaction by External ID","href":"/api-reference/transaction/read-transaction-by-external-id"},{"openapi":"post /v3/transactions/incentive-estimate","title":"Estimate Incentives","href":"/api-reference/transaction/estimate-incentives"},{"openapi":"post /v3/transactions/queue","title":"Queue Transaction","href":"/api-reference/transaction/queue-transaction"},{"openapi":"post /v3/transactions/queue/create","title":"Queue Transaction Create Request","href":"/api-reference/transaction/queue-transaction-create-request"},{"openapi":"post /v3/transactions/{id}/resend","title":"Resend Transaction Payload","href":"/api-reference/transaction/resend-transaction-payload"},{"openapi":"post /v3/transactions/{transaction}/event-trigger","title":"Trigger Transaction Event","href":"/api-reference/transaction/trigger-transaction-event"},{"openapi":"post /v3/transactions/batch.json","title":"Batch Transactions","href":"/api-reference/transaction/batch-transactions"}]},{"group":"Transaction Item","pages":[{"title":"Transaction Items","href":"/api-reference/transaction-item/overview"},{"openapi":"get /v3/transactions/{transaction}/items","title":"Browse Transaction Items","href":"/api-reference/transaction-item/browse-transaction-items"},{"openapi":"post /v3/transactions/{transaction}/items","title":"Add Transaction Item","href":"/api-reference/transaction-item/add-transaction-item"},{"openapi":"get /v3/transactions/{transaction}/items/{item}","title":"Read Transaction Item","href":"/api-reference/transaction-item/read-transaction-item"},{"openapi":"delete /v3/transactions/{transaction}/items/{item}","title":"Delete a transaction item","href":"/api-reference/transaction-item/delete-a-transaction-item"},{"openapi":"put /v3/transactions/items/{transactionitem}","title":"Recalculate Transaction Item Achievement Points","href":"/api-reference/transaction-item/recalculate-transaction-item-achievement-points"},{"openapi":"post /v3/transactions/items/{id}/resend","title":"Resend Transaction Item Payload","href":"/api-reference/transaction-item/resend-transaction-item-payload"},{"openapi":"post /v3/transactions/items/{transactionitem}/list-item","title":"Link Transaction Item to List Item","href":"/api-reference/transaction-item/link-transaction-item-to-list-item"},{"openapi":"post /v3/profiles/{profile}/transactions/items/{transactionitem}/list-item","title":"Link Profile Transaction Item to List Item","href":"/api-reference/transaction-item/link-profile-transaction-item-to-list-item"}]},{"group":"Transaction Custom Field","pages":[{"openapi":"get /v3/transactions/{transaction}/custom-fields","title":"Browse Transaction Custom Fields","href":"/api-reference/transaction-custom-field/browse-transaction-custom-fields"},{"openapi":"post /v3/transactions/{transaction}/custom-fields","title":"Add Transaction Custom Field","href":"/api-reference/transaction-custom-field/add-transaction-custom-field"},{"openapi":"get /v3/transactions/{transaction}/custom-fields/{customField}","title":"Read Transaction Custom Field","href":"/api-reference/transaction-custom-field/read-transaction-custom-field"},{"openapi":"put /v3/transactions/{transaction}/custom-fields/{customField}","title":"Edit Transaction Custom Field","href":"/api-reference/transaction-custom-field/edit-transaction-custom-field"},{"openapi":"delete /v3/transactions/{transaction}/custom-fields/{customField}","title":"Delete Transaction Custom Field","href":"/api-reference/transaction-custom-field/delete-transaction-custom-field"}]},{"group":"Profile Transaction","pages":[{"openapi":"get /v3/profiles/{profile}/transactions","title":"Browse Profile Transactions","href":"/api-reference/profile-transaction/browse-profile-transactions"},{"openapi":"get /v3/profiles/{profile}/transactions/{transaction}","title":"Read Profile Transaction","href":"/api-reference/profile-transaction/read-profile-transaction"},{"openapi":"get /v3/profiles/{profile}/find-transactions","title":"Search Profile Transactions","href":"/api-reference/profile-transaction/search-profile-transactions"},{"openapi":"get /v3/profiles/{profile}/group_transactions","title":"Browse Grouped Profile Transactions","href":"/api-reference/profile-transaction/browse-grouped-profile-transactions"},{"openapi":"get /v3/profiles/{profile}/transaction-products","title":"Browse Profile Transaction Products","href":"/api-reference/profile-transaction/browse-profile-transaction-products"},{"openapi":"get /v3/profiles/{profile}/transactions/{transaction}/unattach","title":"Detach Profile from Transaction","href":"/api-reference/profile-transaction/detach-profile-from-transaction"}]},{"group":"Profile Transaction Item","pages":[{"openapi":"get /v3/profiles/{profile}/transactionitems/list/{type}","title":"Browse Profile Transaction Items","href":"/api-reference/profile-transaction-item/browse-profile-transaction-items"}]},{"group":"Profile Transaction Claim","pages":[{"openapi":"get /v3/profiles/{profile}/transactions/claims","title":"Browse Profile Transaction Claims","href":"/api-reference/profile-transaction-claim/browse-profile-transaction-claims"},{"openapi":"post /v3/profiles/{profile}/transactions/claims","title":"Add Profile Transaction Claim","href":"/api-reference/profile-transaction-claim/add-profile-transaction-claim"},{"openapi":"get /v3/profiles/{profile}/transactions/claims/{transactionClaim}","title":"Read Profile Transaction Claim","href":"/api-reference/profile-transaction-claim/read-profile-transaction-claim"},{"openapi":"delete /v3/profiles/{profile}/transactions/claims/{transactionClaim}","title":"Delete Profile Transaction Claim","href":"/api-reference/profile-transaction-claim/delete-profile-transaction-claim"}]},{"group":"Order","pages":[{"openapi":"get /v3/orders","title":"Browse Orders","href":"/api-reference/order/browse-orders"},{"openapi":"post /v3/orders","title":"Add Order","href":"/api-reference/order/add-order"},{"openapi":"get /v3/orders/{order}","title":"Read Order","href":"/api-reference/order/read-order"},{"openapi":"put /v3/orders/{order}","title":"Edit Order","href":"/api-reference/order/edit-order"},{"openapi":"delete /v3/orders/{order}","title":"Delete Order","href":"/api-reference/order/delete-order"},{"openapi":"post /v3/orders/queue","title":"Queue Order Create Request","href":"/api-reference/order/queue-order-create-request"},{"openapi":"post /v3/orders/queue/create","title":"Queue Order Create Request","href":"/api-reference/order/queue-order-create-request-1"},{"openapi":"post /v3/orders/{id}/resend","title":"Resend Order Payload","href":"/api-reference/order/resend-order-payload"},{"openapi":"post /v3/orders/batch.json","title":"Batch Orders","href":"/api-reference/order/batch-orders"}]},{"group":"Order Item","pages":[{"openapi":"get /v3/orders/{order}/items","title":"Browse Order Items","href":"/api-reference/order-item/browse-order-items"},{"openapi":"post /v3/orders/{order}/items","title":"Add Order Item","href":"/api-reference/order-item/add-order-item"},{"openapi":"get /v3/orders/{order}/items/{item}","title":"Read Order Item","href":"/api-reference/order-item/read-order-item"},{"openapi":"put /v3/orders/{order}/items/{item}","title":"Edit Order Item","href":"/api-reference/order-item/edit-order-item"},{"openapi":"delete /v3/orders/{order}/items/{item}","title":"Delete an order item","href":"/api-reference/order-item/delete-an-order-item"}]},{"group":"Profile Order","pages":[{"openapi":"get /v3/profiles/{profile}/orders","title":"Browse Profile Orders","href":"/api-reference/profile-order/browse-profile-orders"},{"openapi":"get /v3/profiles/{profile}/orders/{order}","title":"Read Profile Order","href":"/api-reference/profile-order/read-profile-order"},{"openapi":"get /v3/profiles/{profile}/group_orders","title":"Browse Grouped Profile Orders","href":"/api-reference/profile-order/browse-grouped-profile-orders"}]},{"group":"Product","pages":[{"title":"Products","href":"/api-reference/product/overview"},{"openapi":"get /v3/products","title":"Browse Products","href":"/api-reference/product/browse-products"},{"openapi":"post /v3/products","title":"Add Product","href":"/api-reference/product/add-product"},{"openapi":"get /v3/products/{product}","title":"Read Product","href":"/api-reference/product/read-product"},{"openapi":"put /v3/products/{product}","title":"Edit Product","href":"/api-reference/product/edit-product"},{"openapi":"delete /v3/products/{product}","title":"Delete Product","href":"/api-reference/product/delete-product"},{"openapi":"post /v3/products/create-update","title":"Update or Create Product","href":"/api-reference/product/update-or-create-product"},{"openapi":"post /v3/products/update-create","title":"Update or Create Product","href":"/api-reference/product/update-or-create-product-1"},{"openapi":"post /v3/products/queue","title":"Queue Product","href":"/api-reference/product/queue-product"},{"openapi":"post /v3/products/batch.json","title":"Batch Products","href":"/api-reference/product/batch-products"}]},{"group":"Product Variant","pages":[{"title":"Product Variants","href":"/api-reference/product-variant/overview"},{"openapi":"get /v3/products/variants","title":"Browse Product Variants","href":"/api-reference/product-variant/browse-product-variants"},{"openapi":"get /v3/products/{product}/variants","title":"Browse Product Variants","href":"/api-reference/product-variant/browse-product-variants-1"},{"openapi":"post /v3/products/{product}/variants","title":"Add Product Variant","href":"/api-reference/product-variant/add-product-variant"},{"openapi":"get /v3/products/{product}/variants/{variant}","title":"Read Product Variant","href":"/api-reference/product-variant/read-product-variant"},{"openapi":"put /v3/products/{product}/variants/{variant}","title":"Edit Product Variant","href":"/api-reference/product-variant/edit-product-variant"},{"openapi":"delete /v3/products/{product}/variants/{variant}","title":"Delete Product Variant","href":"/api-reference/product-variant/delete-product-variant"}]},{"group":"Custom Product","pages":[{"openapi":"get /v3/customProducts","title":"Browse Custom Products","href":"/api-reference/custom-product/browse-custom-products"},{"openapi":"post /v3/customProducts","title":"Add Custom Product","href":"/api-reference/custom-product/add-custom-product"},{"openapi":"get /v3/customProducts/{customProduct}","title":"Read Custom Product","href":"/api-reference/custom-product/read-custom-product"},{"openapi":"put /v3/customProducts/{customProduct}","title":"Edit Custom Product","href":"/api-reference/custom-product/edit-custom-product"},{"openapi":"delete /v3/customProducts/{customProduct}","title":"Delete Custom Product","href":"/api-reference/custom-product/delete-custom-product"}]},{"group":"Location","pages":[{"title":"Locations","href":"/api-reference/location/overview"},{"openapi":"get /v3/locations","title":"Browse Locations","href":"/api-reference/location/browse-locations"},{"openapi":"post /v3/locations","title":"Add Location","href":"/api-reference/location/add-location"},{"openapi":"get /v3/locations/{location}","title":"Read Location","href":"/api-reference/location/read-location"},{"openapi":"put /v3/locations/{location}","title":"Edit Location","href":"/api-reference/location/edit-location"},{"openapi":"delete /v3/locations/{location}","title":"Delete Location","href":"/api-reference/location/delete-location"},{"openapi":"get /v3/locations/{idType}/{id}","title":"Read Location By External","href":"/api-reference/location/read-location-by-external"},{"openapi":"post /v3/locations/batch.json","title":"Batch Locations","href":"/api-reference/location/batch-locations"}]},{"group":"Location Custom Field","pages":[{"openapi":"get /v3/locations/{location}/custom-fields","title":"Browse Location Custom Fields","href":"/api-reference/location-custom-field/browse-location-custom-fields"},{"openapi":"post /v3/locations/{location}/custom-fields","title":"Add Location Custom Field","href":"/api-reference/location-custom-field/add-location-custom-field"},{"openapi":"get /v3/locations/{location}/custom-fields/{customField}","title":"Read Location Custom Field","href":"/api-reference/location-custom-field/read-location-custom-field"},{"openapi":"put /v3/locations/{location}/custom-fields/{customField}","title":"Edit Location Custom Field","href":"/api-reference/location-custom-field/edit-location-custom-field"},{"openapi":"delete /v3/locations/{location}/custom-fields/{customField}","title":"Delete Location Custom Field","href":"/api-reference/location-custom-field/delete-location-custom-field"}]},{"group":"Location Profile","pages":[{"openapi":"post /v3/locations/{location}/profiles","title":"Add Location Profile","href":"/api-reference/location-profile/add-location-profile"},{"openapi":"get /v3/locations/{location}/profiles","title":"Browse Location Profiles","href":"/api-reference/location-profile/browse-location-profiles"},{"openapi":"get /v3/profiles/{profile}/locations","title":"Browse Profile Locations","href":"/api-reference/location-profile/browse-profile-locations"},{"openapi":"delete /v3/location-profiles/{locationProfile}","title":"Delete Location Profile","href":"/api-reference/location-profile/delete-location-profile"},{"openapi":"get /v3/location-profiles/{locationProfile}","title":"Read Location Profile","href":"/api-reference/location-profile/read-location-profile"},{"openapi":"put /v3/location-profiles/{locationProfile}","title":"Update Location Profile","href":"/api-reference/location-profile/update-location-profile"}]},{"group":"Appointment","pages":[{"openapi":"post /v3/appointments","title":"Add Appointment","href":"/api-reference/appointment/add-appointment"},{"openapi":"get /v3/appointments","title":"Browse Appointments","href":"/api-reference/appointment/browse-appointments"},{"openapi":"delete /v3/appointments/{appointment}","title":"Delete Appointment","href":"/api-reference/appointment/delete-appointment"},{"openapi":"get /v3/appointments/{appointment}","title":"Read Appointment","href":"/api-reference/appointment/read-appointment"},{"openapi":"put /v3/appointments/{appointment}","title":"Update Appointment","href":"/api-reference/appointment/update-appointment"}]},{"group":"Appointment Definition","pages":[{"openapi":"post /v3/appointment-definitions","title":"Add Appointment Definition","href":"/api-reference/appointment-definition/add-appointment-definition"},{"openapi":"get /v3/appointment-definitions","title":"Browse Appointment Definitions","href":"/api-reference/appointment-definition/browse-appointment-definitions"},{"openapi":"delete /v3/appointment-definitions/{appointmentDefinition}","title":"Delete Appointment Definition","href":"/api-reference/appointment-definition/delete-appointment-definition"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}","title":"Read Appointment Definition","href":"/api-reference/appointment-definition/read-appointment-definition"},{"openapi":"put /v3/appointment-definitions/{appointmentDefinition}","title":"Update Appointment Definition","href":"/api-reference/appointment-definition/update-appointment-definition"}]},{"group":"Appointment Definition Location","pages":[{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/locations","title":"Add Appointment Definition Location","href":"/api-reference/appointment-definition-location/add-appointment-definition-location"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/locations","title":"Browse Appointment Definition Locations","href":"/api-reference/appointment-definition-location/browse-appointment-definition-locations"},{"openapi":"delete /v3/appointment-definitions/{appointmentDefinition}/locations/{location}","title":"Delete Appointment Definition Location","href":"/api-reference/appointment-definition-location/delete-appointment-definition-location"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/locations/{location}","title":"Read Appointment Definition Location","href":"/api-reference/appointment-definition-location/read-appointment-definition-location"},{"openapi":"put /v3/appointment-definitions/{appointmentDefinition}/locations/{location}","title":"Update Appointment Definition Location","href":"/api-reference/appointment-definition-location/update-appointment-definition-location"}]},{"group":"Appointment Definition Normal Hour","pages":[{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/normal-hours","title":"Add Appointment Definition Normal Hour","href":"/api-reference/appointment-definition-normal-hour/add-appointment-definition-normal-hour"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/normal-hours","title":"Browse Appointment Definition Normal Hours","href":"/api-reference/appointment-definition-normal-hour/browse-appointment-definition-normal-hours"},{"openapi":"delete /v3/appointment-definitions/{appointmentDefinition}/normal-hours/{normalHour}","title":"Delete Appointment Definition Normal Hour","href":"/api-reference/appointment-definition-normal-hour/delete-appointment-definition-normal-hour"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/normal-hours/{normalHour}","title":"Read Appointment Definition Normal Hour","href":"/api-reference/appointment-definition-normal-hour/read-appointment-definition-normal-hour"},{"openapi":"put /v3/appointment-definitions/{appointmentDefinition}/normal-hours/{normalHour}","title":"Update Appointment Definition Normal Hour","href":"/api-reference/appointment-definition-normal-hour/update-appointment-definition-normal-hour"}]},{"group":"Appointment Definition Questions","pages":[{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/questions","title":"Browse Appointment Definition Questions","href":"/api-reference/appointment-definition-questions/browse-appointment-definition-questions"}]},{"group":"Appointment Definition Special Hour","pages":[{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/special-hours","title":"Add Appointment Definition Special Hour","href":"/api-reference/appointment-definition-special-hour/add-appointment-definition-special-hour"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/special-hours","title":"Browse Appointment Definition Special Hours","href":"/api-reference/appointment-definition-special-hour/browse-appointment-definition-special-hours"},{"openapi":"delete /v3/appointment-definitions/{appointmentDefinition}/special-hours/{specialHour}","title":"Delete Appointment Definition Special Hour","href":"/api-reference/appointment-definition-special-hour/delete-appointment-definition-special-hour"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/special-hours/{specialHour}","title":"Read Appointment Definition Special Hour","href":"/api-reference/appointment-definition-special-hour/read-appointment-definition-special-hour"},{"openapi":"put /v3/appointment-definitions/{appointmentDefinition}/special-hours/{specialHour}","title":"Update Appointment Definition Special Hour","href":"/api-reference/appointment-definition-special-hour/update-appointment-definition-special-hour"}]},{"group":"Appointment Definition Staff","pages":[{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/staff","title":"Add Appointment Definition Staff","href":"/api-reference/appointment-definition-staff/add-appointment-definition-staff"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/staff","title":"Browse Appointment Definition Staff","href":"/api-reference/appointment-definition-staff/browse-appointment-definition-staff"},{"openapi":"delete /v3/appointment-definitions/{appointmentDefinition}/staff/{definitionStaff}","title":"Delete Appointment Definition Staff","href":"/api-reference/appointment-definition-staff/delete-appointment-definition-staff"},{"openapi":"get /v3/appointment-definitions/{appointmentDefinition}/staff/{definitionStaff}","title":"Read Appointment Definition Staff","href":"/api-reference/appointment-definition-staff/read-appointment-definition-staff"},{"openapi":"put /v3/appointment-definitions/{appointmentDefinition}/staff/{definitionStaff}","title":"Update Appointment Definition Staff","href":"/api-reference/appointment-definition-staff/update-appointment-definition-staff"}]},{"group":"Appointment Availability","pages":[{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/available-slots-range","title":"Browse Available Appointment Slots over a Date Range","href":"/api-reference/appointment-availability/browse-available-appointment-slots-over-a-date-range"},{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/available-slots","title":"Browse Available Appointment Slots","href":"/api-reference/appointment-availability/browse-available-appointment-slots"},{"openapi":"post /v3/appointment-definitions/{appointmentDefinition}/available-staff","title":"Browse Available Appointment Staff","href":"/api-reference/appointment-availability/browse-available-appointment-staff"}]},{"group":"Appointment Link","pages":[{"openapi":"post /v3/appointments/{appointment}/link","title":"Link Appointment","href":"/api-reference/appointment-link/link-appointment"},{"openapi":"post /v3/appointments/{appointment}/unlink","title":"Unlink Appointment","href":"/api-reference/appointment-link/unlink-appointment"}]},{"group":"Appointment Queue","pages":[{"openapi":"post /v3/appointment-queues","title":"Add Appointment Queue","href":"/api-reference/appointment-queue/add-appointment-queue"},{"openapi":"get /v3/appointment-queues","title":"Browse Appointment Queues","href":"/api-reference/appointment-queue/browse-appointment-queues"},{"openapi":"delete /v3/appointment-queues/{appointmentQueue}","title":"Delete Appointment Queue","href":"/api-reference/appointment-queue/delete-appointment-queue"},{"openapi":"get /v3/appointment-queues/{appointmentQueue}","title":"Read Appointment Queue","href":"/api-reference/appointment-queue/read-appointment-queue"},{"openapi":"put /v3/appointment-queues/{appointmentQueue}","title":"Update Appointment Queue","href":"/api-reference/appointment-queue/update-appointment-queue"}]},{"group":"Appointment Waitlist","pages":[{"openapi":"post /v3/appointment-waitlists","title":"Add Appointment Waitlist","href":"/api-reference/appointment-waitlist/add-appointment-waitlist"},{"openapi":"get /v3/appointment-waitlists","title":"Browse Appointment Waitlists","href":"/api-reference/appointment-waitlist/browse-appointment-waitlists"},{"openapi":"delete /v3/appointment-waitlists/{appointmentWaitlist}","title":"Delete Appointment Waitlist","href":"/api-reference/appointment-waitlist/delete-appointment-waitlist"},{"openapi":"get /v3/appointment-waitlists/{appointmentWaitlist}","title":"Read Appointment Waitlist","href":"/api-reference/appointment-waitlist/read-appointment-waitlist"},{"openapi":"put /v3/appointment-waitlists/{appointmentWaitlist}","title":"Update Appointment Waitlist","href":"/api-reference/appointment-waitlist/update-appointment-waitlist"}]},{"group":"Profile Appointment","pages":[{"openapi":"post /v3/profiles/{profile}/appointments","title":"Add Profile Appointment","href":"/api-reference/profile-appointment/add-profile-appointment"},{"openapi":"get /v3/profiles/{profile}/appointments","title":"Browse Profile Appointments","href":"/api-reference/profile-appointment/browse-profile-appointments"},{"openapi":"delete /v3/profiles/{profile}/appointments/{appointment}","title":"Delete Profile Appointment","href":"/api-reference/profile-appointment/delete-profile-appointment"},{"openapi":"get /v3/profiles/{profile}/appointments/{appointment}","title":"Read Profile Appointment","href":"/api-reference/profile-appointment/read-profile-appointment"},{"openapi":"put /v3/profiles/{profile}/appointments/{appointment}","title":"Update Profile Appointment","href":"/api-reference/profile-appointment/update-profile-appointment"},{"openapi":"get /v3/profiles/{profile}/appointment-definitions/visibility","title":"Browse Visible Appointment Definitions","href":"/api-reference/profile-appointment/browse-visible-appointment-definitions"}]},{"group":"Profile Normal Hour","pages":[{"openapi":"post /v3/profiles/{profile}/normal-hours","title":"Add Profile Normal Hour","href":"/api-reference/profile-normal-hour/add-profile-normal-hour"},{"openapi":"get /v3/profiles/{profile}/normal-hours","title":"Browse Profile Normal Hours","href":"/api-reference/profile-normal-hour/browse-profile-normal-hours"},{"openapi":"delete /v3/profiles/{profile}/normal-hours/{normalHour}","title":"Delete Profile Normal Hour","href":"/api-reference/profile-normal-hour/delete-profile-normal-hour"},{"openapi":"get /v3/profiles/{profile}/normal-hours/{normalHour}","title":"Read Profile Normal Hour","href":"/api-reference/profile-normal-hour/read-profile-normal-hour"},{"openapi":"put /v3/profiles/{profile}/normal-hours/{normalHour}","title":"Update Profile Normal Hour","href":"/api-reference/profile-normal-hour/update-profile-normal-hour"}]},{"group":"Profile Special Hour","pages":[{"openapi":"post /v3/profiles/{profile}/special-hours","title":"Add Profile Special Hour","href":"/api-reference/profile-special-hour/add-profile-special-hour"},{"openapi":"get /v3/profiles/{profile}/special-hours","title":"Browse Profile Special Hours","href":"/api-reference/profile-special-hour/browse-profile-special-hours"},{"openapi":"delete /v3/profiles/{profile}/special-hours/{specialHour}","title":"Delete Profile Special Hour","href":"/api-reference/profile-special-hour/delete-profile-special-hour"},{"openapi":"get /v3/profiles/{profile}/special-hours/{specialHour}","title":"Read Profile Special Hour","href":"/api-reference/profile-special-hour/read-profile-special-hour"},{"openapi":"put /v3/profiles/{profile}/special-hours/{specialHour}","title":"Update Profile Special Hour","href":"/api-reference/profile-special-hour/update-profile-special-hour"}]}]},{"group":"Incentives","pages":[{"group":"Reward","pages":[{"title":"Rewards","href":"/api-reference/reward/overview"},{"openapi":"get /v3/rewards","title":"Browse Rewards","href":"/api-reference/reward/browse-rewards"},{"openapi":"post /v3/rewards","title":"Add Reward","href":"/api-reference/reward/add-reward"},{"openapi":"get /v3/rewards/{reward}","title":"Read Reward","href":"/api-reference/reward/read-reward"},{"openapi":"put /v3/rewards/{reward}","title":"Edit Reward","href":"/api-reference/reward/edit-reward"},{"openapi":"delete /v3/rewards/{reward}","title":"Delete Reward","href":"/api-reference/reward/delete-reward"},{"openapi":"post /v3/rewards/extend","title":"Extend Reward","href":"/api-reference/reward/extend-reward"},{"openapi":"post /v3/rewards/batch.json","title":"Batch Rewards","href":"/api-reference/reward/batch-rewards"},{"openapi":"get /v3/rewards/{reward}/trigger-target/{type}","title":"Read Reward Trigger Target","href":"/api-reference/reward/read-reward-trigger-target"}]},{"group":"Reward Definition","pages":[{"title":"Reward Definitions","href":"/api-reference/reward-definition/overview"},{"openapi":"get /v3/rewards/definitions","title":"Browse Reward Definitions","href":"/api-reference/reward-definition/browse-reward-definitions"},{"openapi":"post /v3/rewards/definitions","title":"Add Reward Definition","href":"/api-reference/reward-definition/add-reward-definition"},{"openapi":"get /v3/rewards/definitions/{definition}","title":"Read Reward Definition","href":"/api-reference/reward-definition/read-reward-definition"},{"openapi":"put /v3/rewards/definitions/{definition}","title":"Update a reward definition","href":"/api-reference/reward-definition/update-a-reward-definition"},{"openapi":"delete /v3/rewards/definitions/{definition}","title":"Delete Reward Definition","href":"/api-reference/reward-definition/delete-reward-definition"}]},{"group":"Profile Reward","pages":[{"openapi":"get /v3/profiles/{profile}/rewards","title":"Browse Profile Rewards","href":"/api-reference/profile-reward/browse-profile-rewards"},{"openapi":"get /v3/profiles/{profile}/rewards/{reward}","title":"Read Profile Reward","href":"/api-reference/profile-reward/read-profile-reward"}]},{"group":"Point","pages":[{"title":"Points","href":"/api-reference/point/overview"},{"openapi":"get /v3/points","title":"Browse Points","href":"/api-reference/point/browse-points"},{"openapi":"post /v3/points","title":"Add Point","href":"/api-reference/point/add-point"},{"openapi":"get /v3/points/{point}","title":"Read Point","href":"/api-reference/point/read-point"}]},{"group":"Point Definition","pages":[{"title":"Point Definitions","href":"/api-reference/point-definition/overview"},{"openapi":"get /v3/points/definitions","title":"Browse Point Definitions","href":"/api-reference/point-definition/browse-point-definitions"},{"openapi":"post /v3/points/definitions","title":"Add Point Definition","href":"/api-reference/point-definition/add-point-definition"},{"openapi":"get /v3/points/definitions/{definition}","title":"Read Point Definition","href":"/api-reference/point-definition/read-point-definition"},{"openapi":"put /v3/points/definitions/{definition}","title":"Edit Point Definition","href":"/api-reference/point-definition/edit-point-definition"},{"openapi":"delete /v3/points/definitions/{definition}","title":"Delete Point Definition","href":"/api-reference/point-definition/delete-point-definition"}]},{"group":"Profile Point","pages":[{"openapi":"get /v3/profiles/{profile}/points","title":"Browse Profile Points","href":"/api-reference/profile-point/browse-profile-points"},{"openapi":"get /v3/profiles/{profile}/points/{point}","title":"Read Profile Point","href":"/api-reference/profile-point/read-profile-point"},{"openapi":"get /v3/profiles/{profile}/linked_points","title":"Browse Linked Profile Points","href":"/api-reference/profile-point/browse-linked-profile-points"}]},{"group":"Benefit","pages":[{"title":"Benefits","href":"/api-reference/benefit/overview"},{"openapi":"get /v3/benefits","title":"Browse Benefits","href":"/api-reference/benefit/browse-benefits"},{"openapi":"post /v3/benefits","title":"Add Benefit","href":"/api-reference/benefit/add-benefit"},{"openapi":"get /v3/benefits/{benefit}","title":"Read Benefit","href":"/api-reference/benefit/read-benefit"},{"openapi":"put /v3/benefits/{benefit}","title":"Edit Benefit","href":"/api-reference/benefit/edit-benefit"},{"openapi":"delete /v3/benefits/{benefit}","title":"Delete Benefit","href":"/api-reference/benefit/delete-benefit"},{"openapi":"post /v3/benefits/extend","title":"Extend Benefit","href":"/api-reference/benefit/extend-benefit"},{"openapi":"get /v3/benefits.count","title":"Read Benefits Count","href":"/api-reference/benefit/read-benefits-count"},{"openapi":"get /v3/benefits/{benefit}/trigger-target/{type}","title":"Read Benefit Trigger Target","href":"/api-reference/benefit/read-benefit-trigger-target"},{"openapi":"post /v3/benefits/batch.json","title":"Batch Benefits","href":"/api-reference/benefit/batch-benefits"}]},{"group":"Benefit Definition","pages":[{"title":"Benefit Definitions","href":"/api-reference/benefit-definition/overview"},{"openapi":"get /v3/benefits/definitions","title":"Browse Benefit Definitions","href":"/api-reference/benefit-definition/browse-benefit-definitions"},{"openapi":"get /v3/benefits/definitions/campaigns","title":"Browse Benefit Definitions grouped by Campaign","href":"/api-reference/benefit-definition/browse-benefit-definitions-grouped-by-campaign"},{"openapi":"post /v3/benefits/definitions","title":"Add Benefit Definition","href":"/api-reference/benefit-definition/add-benefit-definition"},{"openapi":"get /v3/benefits/definitions/{definition}","title":"Read Benefit Definition","href":"/api-reference/benefit-definition/read-benefit-definition"},{"openapi":"put /v3/benefits/definitions/{definition}","title":"Edit Benefit Definition","href":"/api-reference/benefit-definition/edit-benefit-definition"},{"openapi":"delete /v3/benefits/definitions/{definition}","title":"Delete Benefit Definition","href":"/api-reference/benefit-definition/delete-benefit-definition"},{"openapi":"post /v3/benefits/definitions/{benefitdefinition}/clone","title":"Clone a Benefit Definition","href":"/api-reference/benefit-definition/clone-a-benefit-definition"},{"openapi":"get /v3/benefits/definitions/handle/{handle}","title":"Read Benefit Definition by Handle","href":"/api-reference/benefit-definition/read-benefit-definition-by-handle"},{"openapi":"get /v3/benefits/definitions/{definition}/download-csv","title":"Download Benefit Definition Benefits CSV","href":"/api-reference/benefit-definition/download-benefit-definition-benefits-csv"}]},{"group":"Profile Benefit","pages":[{"openapi":"get /v3/profiles/{profile}/benefits","title":"Browse Profile Benefits","href":"/api-reference/profile-benefit/browse-profile-benefits"},{"openapi":"get /v3/profiles/{profile}/redeemable_benefits","title":"Browse Profile Redeemable Benefits","href":"/api-reference/profile-benefit/browse-profile-redeemable-benefits"},{"openapi":"get /v3/profiles/{profile}/benefits/claimable","title":"Browse Profile Claimable Benefits","href":"/api-reference/profile-benefit/browse-profile-claimable-benefits"},{"openapi":"get /v3/profiles/{profile}/benefits/viewable","title":"Browse Viewable Profile Benefits","href":"/api-reference/profile-benefit/browse-viewable-profile-benefits"},{"openapi":"get /v3/profiles/{profile}/benefits/visibility","title":"Retrieve benefit definitions matching the profile's visibility condition","href":"/api-reference/profile-benefit/retrieve-benefit-definitions-matching-the-profiles-visibility-condition"},{"openapi":"post /v3/profiles/{profile}/benefits/claim","title":"Claim Benefit","href":"/api-reference/profile-benefit/claim-benefit"},{"openapi":"post /v3/profiles/{profile}/benefits/claim-redeem","title":"Add and Redeem Benefit Claim","href":"/api-reference/profile-benefit/add-and-redeem-benefit-claim"},{"openapi":"get /v3/profiles/{profile}/benefits/{benefit}","title":"Read Profile Benefit","href":"/api-reference/profile-benefit/read-profile-benefit"},{"openapi":"put /v3/profiles/{profile}/benefits/{benefit}","title":"Update a profile Benefit","href":"/api-reference/profile-benefit/update-a-profile-benefit"},{"openapi":"delete /v3/profiles/{profile}/benefits/{benefit}","title":"Delete Benefit","href":"/api-reference/profile-benefit/delete-benefit"}]},{"group":"Benefit Redeem","pages":[{"openapi":"post /v3/profiles/{profile}/benefits/{benefit}/redeem","title":"Add Benefit Redemption","href":"/api-reference/benefit-redeem/add-benefit-redemption"},{"openapi":"post /v3/redemptions/{redemption}/benefit/return","title":"Add Benefit Return","href":"/api-reference/benefit-redeem/add-benefit-return"}]},{"group":"Credit","pages":[{"openapi":"get /v3/credits","title":"Browse Credits","href":"/api-reference/credit/browse-credits"},{"openapi":"post /v3/credits","title":"Add Credit","href":"/api-reference/credit/add-credit"},{"openapi":"get /v3/credits/{credit}","title":"Read Credit","href":"/api-reference/credit/read-credit"},{"openapi":"put /v3/credits/{credit}","title":"Edit Credit","href":"/api-reference/credit/edit-credit"},{"openapi":"delete /v3/credits/{credit}","title":"Delete Credit","href":"/api-reference/credit/delete-credit"},{"openapi":"post /v3/credits/extend","title":"Extend Credit","href":"/api-reference/credit/extend-credit"}]},{"group":"Credit Definition","pages":[{"openapi":"get /v3/credits/definitions","title":"Browse Credit Definitions","href":"/api-reference/credit-definition/browse-credit-definitions"},{"openapi":"post /v3/credits/definitions","title":"Add Credit Definition","href":"/api-reference/credit-definition/add-credit-definition"},{"openapi":"get /v3/credits/definitions/{definition}","title":"Read Credit Definition","href":"/api-reference/credit-definition/read-credit-definition"},{"openapi":"put /v3/credits/definitions/{definition}","title":"Edit Credit Definition","href":"/api-reference/credit-definition/edit-credit-definition"},{"openapi":"delete /v3/credits/definitions/{definition}","title":"Delete Credit Definition","href":"/api-reference/credit-definition/delete-credit-definition"}]},{"group":"Profile Credit","pages":[{"openapi":"get /v3/profiles/{profile}/credits","title":"Browse Profile Credits","href":"/api-reference/profile-credit/browse-profile-credits"},{"openapi":"post /v3/profiles/{profile}/credits/{credit}/redeem","title":"Redeem Profile Credit","href":"/api-reference/profile-credit/redeem-profile-credit"}]},{"group":"Tier","pages":[{"title":"Tier","href":"/api-reference/profile-tier/overview"},{"openapi":"get /v3/profiles/{profile}/tiers","title":"Read Profile Tier","href":"/api-reference/profile-tier/read-profile-tier"},{"openapi":"post /v3/profiles/{profile}/tiers/assign","title":"Assign Profile Tier","href":"/api-reference/profile-tier/assign-profile-tier"},{"openapi":"get /v3/profiles/{profile}/tiers/calculate","title":"Calculate Profile Tier","href":"/api-reference/profile-tier/calculate-profile-tier"},{"openapi":"post /v3/profile/tiers/calculate/batch.json","title":"Batch Calculate Profile Tiers","href":"/api-reference/profile-tier/batch-calculate-profile-tiers"}]},{"group":"Tier Definition","pages":[{"title":"Tier Definitions","href":"/api-reference/tier-definition/overview"},{"openapi":"get /v3/tiers/definitions","title":"Browse Tier Definitions","href":"/api-reference/tier-definition/browse-tier-definitions"},{"openapi":"post /v3/tiers/definitions","title":"Add Tier Definition","href":"/api-reference/tier-definition/add-tier-definition"},{"openapi":"get /v3/tiers/definitions/{definition}","title":"Read Tier Definition","href":"/api-reference/tier-definition/read-tier-definition"},{"openapi":"put /v3/tiers/definitions/{definition}","title":"Edit Tier Definition","href":"/api-reference/tier-definition/edit-tier-definition"},{"openapi":"delete /v3/tiers/definitions/{definition}","title":"Delete Tier Definition","href":"/api-reference/tier-definition/delete-tier-definition"}]},{"group":"Tier Point","pages":[{"openapi":"get /v3/tiers/points","title":"Browse Tier Points","href":"/api-reference/tier-point/browse-tier-points"},{"openapi":"post /v3/tiers/points","title":"Add Tier Point","href":"/api-reference/tier-point/add-tier-point"},{"openapi":"get /v3/tiers/points/{point}","title":"Read Tier Point","href":"/api-reference/tier-point/read-tier-point"},{"openapi":"delete /v3/tiers/points/{point}","title":"Delete Tier Point","href":"/api-reference/tier-point/delete-tier-point"}]},{"group":"Profile Tier Point","pages":[{"openapi":"get /v3/profiles/{profile}/tiers/points","title":"Browse Profile Tier Points","href":"/api-reference/profile-tier-point/browse-profile-tier-points"},{"openapi":"get /v3/profiles/{profile}/tiers/points/by-source","title":"Browse Profile Tier Points by Source","href":"/api-reference/profile-tier-point/browse-profile-tier-points-by-source"}]},{"group":"Achievement Definition","pages":[{"title":"Achievement Definitions","href":"/api-reference/achievement-definition/overview"},{"openapi":"get /v3/achievements/definitions","title":"Browse Achievement Definitions","href":"/api-reference/achievement-definition/browse-achievement-definitions"},{"openapi":"post /v3/achievements/definitions","title":"Add Achievement Definition","href":"/api-reference/achievement-definition/add-achievement-definition"},{"openapi":"get /v3/achievements/definitions/{definition}","title":"Read Achievement Definition","href":"/api-reference/achievement-definition/read-achievement-definition"},{"openapi":"put /v3/achievements/definitions/{definition}","title":"Edit Achievement Definition","href":"/api-reference/achievement-definition/edit-achievement-definition"},{"openapi":"delete /v3/achievements/definitions/{definition}","title":"Delete Achievement Definition","href":"/api-reference/achievement-definition/delete-achievement-definition"}]},{"group":"Profile Achievement","pages":[{"title":"Achievements","href":"/api-reference/profile-achievement/overview"},{"openapi":"get /v3/profiles/{profile}/achievements","title":"Browse Profile Achievements","href":"/api-reference/profile-achievement/browse-profile-achievements"},{"openapi":"post /v3/profiles/{profile}/achievements","title":"Add Profile Achievement","href":"/api-reference/profile-achievement/add-profile-achievement"}]},{"group":"Profile Achievement Point","pages":[{"openapi":"get /v3/profiles/{profile}/achievements/{definition}/achievement-points","title":"Browse Profile Achievement Points","href":"/api-reference/profile-achievement-point/browse-profile-achievement-points"}]},{"group":"Allocation","pages":[{"openapi":"get /v3/allocations","title":"Browse Allocations","href":"/api-reference/allocation/browse-allocations"},{"openapi":"get /v3/allocations/{benefitdefinition}/count","title":"Read Allocation Count","href":"/api-reference/allocation/read-allocation-count"},{"openapi":"post /v3/allocations/batch.json","title":"Batch Allocations","href":"/api-reference/allocation/batch-allocations"}]},{"group":"Redemption","pages":[{"title":"Redemptions","href":"/api-reference/redemption/overview"},{"openapi":"get /v3/redemptions","title":"Browse Redemptions","href":"/api-reference/redemption/browse-redemptions"},{"openapi":"get /v3/redemptions/group/{attribute}","title":"Group Redemptions","href":"/api-reference/redemption/group-redemptions"},{"openapi":"get /v3/redemptions/{redemption}","title":"Read Redemption","href":"/api-reference/redemption/read-redemption"}]},{"group":"Redemption Item","pages":[{"openapi":"get /v3/redemptions/items","title":"Browse Redemption Items","href":"/api-reference/redemption-item/browse-redemption-items"},{"openapi":"get /v3/redemptions/items/{redemptionItem}","title":"Read Redemption Item","href":"/api-reference/redemption-item/read-redemption-item"}]},{"group":"Profile Redemption","pages":[{"openapi":"get /v3/profiles/{profile}/redemptions","title":"Browse Profile Redemptions","href":"/api-reference/profile-redemption/browse-profile-redemptions"},{"openapi":"get /v3/profiles/{profile}/redemptions/{redemption}","title":"Read Profile Redemption","href":"/api-reference/profile-redemption/read-profile-redemption"},{"openapi":"get /v3/profiles/{profile}/linked_redemptions","title":"Browse Linked Profile Redemptions","href":"/api-reference/profile-redemption/browse-linked-profile-redemptions"},{"openapi":"get /v3/profiles/{profile}/linked/redemptions","title":"Browse Linked Profile Redemptions","href":"/api-reference/profile-redemption/browse-linked-profile-redemptions-1"},{"openapi":"get /v3/profiles/{profile}/redemptions/{type}/{id}/count","title":"Read Redemption Count","href":"/api-reference/profile-redemption/read-redemption-count"}]},{"group":"Redeem Strategy","pages":[{"openapi":"post /v3/profiles/{profile}/redeem","title":"Add Reward, Point, or Credit Redemption","href":"/api-reference/redeem-strategy/add-reward-point-or-credit-redemption"}]},{"group":"Return Strategy","pages":[{"openapi":"post /v3/redemptions/{redemption}/return","title":"Add Reward or Point Return","href":"/api-reference/return-strategy/add-reward-or-point-return"},{"openapi":"post /v3/redemptions/{redemption}/reversal","title":"Add Redemption Reversal","href":"/api-reference/return-strategy/add-redemption-reversal"}]},{"group":"Share","pages":[{"openapi":"get /v3/shares","title":"Browse Shares","href":"/api-reference/share/browse-shares"},{"openapi":"post /v3/shares","title":"Add Share","href":"/api-reference/share/add-share"},{"openapi":"get /v3/shares/{share}","title":"Read Share","href":"/api-reference/share/read-share"},{"openapi":"put /v3/shares/{share}","title":"Edit Share","href":"/api-reference/share/edit-share"},{"openapi":"delete /v3/shares/{share}","title":"Delete Share","href":"/api-reference/share/delete-share"},{"openapi":"post /v3/shares/{handle}/claim","title":"Claim Share","href":"/api-reference/share/claim-share"}]}]},{"group":"Lists","pages":[{"group":"Product List","pages":[{"title":"Profile Lists","href":"/api-reference/product-list/overview"},{"openapi":"get /v3/profiles/{profile}/lists","title":"Browse Profile Lists","href":"/api-reference/product-list/browse-profile-lists"},{"openapi":"post /v3/profiles/{profile}/lists","title":"Add Profile List","href":"/api-reference/product-list/add-profile-list"},{"openapi":"get /v3/profiles/{profile}/lists/{handle}","title":"Read Profile List","href":"/api-reference/product-list/read-profile-list"},{"openapi":"put /v3/profiles/{profile}/lists/{list}","title":"Edit Profile List","href":"/api-reference/product-list/edit-profile-list"},{"openapi":"delete /v3/profiles/{profile}/lists/{list}","title":"Delete Profile List","href":"/api-reference/product-list/delete-profile-list"},{"openapi":"get /v3/product-lists/search","title":"Search Product Lists","href":"/api-reference/product-list/search-product-lists"}]},{"group":"Product List Item","pages":[{"openapi":"get /v3/profiles/{profile}/lists/{handle}/items","title":"Read Profile List Items","href":"/api-reference/product-list-item/read-profile-list-items"},{"openapi":"post /v3/profiles/{profile}/lists/{handle}/items","title":"Add Profile List Item","href":"/api-reference/product-list-item/add-profile-list-item"},{"openapi":"get /v3/profiles/{profile}/lists/{handle}/items/{itemId}","title":"Read Profile List Item","href":"/api-reference/product-list-item/read-profile-list-item"},{"openapi":"put /v3/profiles/{profile}/lists/{handle}/items/{itemId}","title":"Edit Profile List Item","href":"/api-reference/product-list-item/edit-profile-list-item"},{"openapi":"delete /v3/profiles/{profile}/lists/{handle}/items/{itemId}","title":"Delete Profile List Item","href":"/api-reference/product-list-item/delete-profile-list-item"},{"openapi":"post /v3/profiles/{profile}/lists/{handle}/custom","title":"Add Custom Product to Profile List","href":"/api-reference/product-list-item/add-custom-product-to-profile-list"}]},{"group":"Product List Reservations","pages":[{"openapi":"get /v3/profiles/{profile_id}/reservations","title":"Browse Profile Reservations","href":"/api-reference/product-list-reservations/browse-profile-reservations"},{"openapi":"post /v3/list/items/{itemId}/reservations","title":"Add List Reservation","href":"/api-reference/product-list-reservations/add-list-reservation"},{"openapi":"get /v3/lists/{list}","title":"Read Product List","href":"/api-reference/product-list-reservations/read-product-list"},{"openapi":"put /v3/list/items/{itemId}/reservations/{reservationId}","title":"Edit List Reservation","href":"/api-reference/product-list-reservations/edit-list-reservation"},{"openapi":"delete /v3/list/items/{itemId}/reservations/{reservationId}","title":"Delete List Reservation","href":"/api-reference/product-list-reservations/delete-list-reservation"}]},{"group":"Product List Share","pages":[{"openapi":"post /v3/profiles/{profile}/lists/{list}/shares","title":"Add Product List Share","href":"/api-reference/product-list-share/add-product-list-share"},{"openapi":"delete /v3/profiles/{profile}/lists/{list}/shares/{share}","title":"Delete Product List Share","href":"/api-reference/product-list-share/delete-product-list-share"},{"openapi":"get /v3/lists/shares/{handle}","title":"Read Shared Product List","href":"/api-reference/product-list-share/read-shared-product-list"},{"openapi":"get /v3/lists/shares/{handle}/no_profile","title":"Read Shared Product List Without Profile","href":"/api-reference/product-list-share/read-shared-product-list-without-profile"}]},{"group":"List Definition","pages":[{"openapi":"get /v3/lists/definitions","title":"Browse List Definitions","href":"/api-reference/list-definition/browse-list-definitions"},{"openapi":"post /v3/lists/definitions","title":"Add List Definition","href":"/api-reference/list-definition/add-list-definition"},{"openapi":"get /v3/lists/definitions/{definition}","title":"Read List Definition","href":"/api-reference/list-definition/read-list-definition"},{"openapi":"put /v3/lists/definitions/{definition}","title":"Edit List Definition","href":"/api-reference/list-definition/edit-list-definition"},{"openapi":"delete /v3/lists/definitions/{definition}","title":"Delete List Definition","href":"/api-reference/list-definition/delete-list-definition"}]},{"group":"List Custom Field","pages":[{"openapi":"get /v3/profiles/{profile}/lists/{list}/custom-fields","title":"Browse List Custom Fields","href":"/api-reference/list-custom-field/browse-list-custom-fields"},{"openapi":"post /v3/profiles/{profile}/lists/{list}/custom-fields","title":"Add List Custom Field","href":"/api-reference/list-custom-field/add-list-custom-field"},{"openapi":"get /v3/profiles/{profile}/lists/{list}/custom-fields/{customField}","title":"Read List Custom Field","href":"/api-reference/list-custom-field/read-list-custom-field"},{"openapi":"put /v3/profiles/{profile}/lists/{list}/custom-fields/{customField}","title":"Edit List Custom Field","href":"/api-reference/list-custom-field/edit-list-custom-field"},{"openapi":"delete /v3/profiles/{profile}/lists/{list}/custom-fields/{customField}","title":"Delete List Custom Field","href":"/api-reference/list-custom-field/delete-list-custom-field"}]}]},{"group":"Groups","pages":[{"group":"Group Definition","pages":[{"title":"Group Definition API","href":"/api-reference/group-definition/overview"},{"openapi":"get /v3/groups/definitions","title":"Browse Group Definitions","href":"/api-reference/group-definition/browse-group-definitions"},{"openapi":"post /v3/groups/definitions","title":"Add Group Definition","href":"/api-reference/group-definition/add-group-definition"},{"openapi":"get /v3/groups/definitions/{group}","title":"Read Group Definition","href":"/api-reference/group-definition/read-group-definition"},{"openapi":"put /v3/groups/definitions/{group}","title":"Edit Group Definition","href":"/api-reference/group-definition/edit-group-definition"},{"openapi":"delete /v3/groups/definitions/{group}","title":"Delete Group Definition","href":"/api-reference/group-definition/delete-group-definition"}]},{"group":"Group Profile","pages":[{"openapi":"get /v3/groups/definitions/{group}/profiles","title":"List members of a group — one endpoint for every type, so consumers never\nbranch. Rows share the {profile_id, record_type, record} shape:","href":"/api-reference/group-profile/list-members-of-a-group-—-one-endpoint-for-every-type-so-consumers-neverbranch-rows-share-the--shape:"},{"openapi":"post /v3/groups/definitions/{group}/profiles","title":"Add a profile to a static group","href":"/api-reference/group-profile/add-a-profile-to-a-static-group"},{"openapi":"post /v3/groups/definitions/{group}/profiles/{profile}/remove","title":"Remove a profile from a static group","href":"/api-reference/group-profile/remove-a-profile-from-a-static-group"}]},{"group":"Group Rule","pages":[{"openapi":"get /v3/groups/definitions/{group}/rules","title":"Browse Group Rules","href":"/api-reference/group-rule/browse-group-rules"},{"openapi":"post /v3/groups/definitions/{group}/rules","title":"Add Group Rule","href":"/api-reference/group-rule/add-group-rule"},{"openapi":"put /v3/groups/definitions/{group}/rules/{rule}","title":"Edit Group Rule","href":"/api-reference/group-rule/edit-group-rule"},{"openapi":"delete /v3/groups/definitions/{group}/rules/{rule}","title":"Delete Group Rule","href":"/api-reference/group-rule/delete-group-rule"}]},{"group":"Group Rule Definition","pages":[{"openapi":"get /v3/groups/rule-definitions","title":null,"href":"/api-reference/group-rule-definition/get-v3groupsrule-definitions"},{"openapi":"post /v3/groups/rule-definitions","title":null,"href":"/api-reference/group-rule-definition/post-v3groupsrule-definitions"},{"openapi":"get /v3/groups/rule-definitions/{ruleDefinition}","title":null,"href":"/api-reference/group-rule-definition/get-v3groupsrule-definitions-1"},{"openapi":"put /v3/groups/rule-definitions/{ruleDefinition}","title":null,"href":"/api-reference/group-rule-definition/put-v3groupsrule-definitions"},{"openapi":"delete /v3/groups/rule-definitions/{ruleDefinition}","title":null,"href":"/api-reference/group-rule-definition/delete-v3groupsrule-definitions"}]},{"group":"Group Snapshot","pages":[{"openapi":"get /v3/groups/definitions/{group}/snapshots","title":"List snapshots for a dynamic group, newest first","href":"/api-reference/group-snapshot/list-snapshots-for-a-dynamic-group-newest-first"},{"openapi":"post /v3/groups/definitions/{group}/snapshots","title":"Start a manual snapshot run for a dynamic group","href":"/api-reference/group-snapshot/start-a-manual-snapshot-run-for-a-dynamic-group"},{"openapi":"get /v3/groups/definitions/{group}/snapshots/{snapshot}/profiles","title":"List one snapshot batch's work items (the per-profile evaluation rows)","href":"/api-reference/group-snapshot/list-one-snapshot-batchs-work-items-the-per-profile-evaluation-rows"}]},{"group":"Group Explain","pages":[{"openapi":"get /v3/groups/definitions/{group}/profiles/{profile}/explain","title":"Explain why a single profile is or isn't in a dynamic group","href":"/api-reference/group-explain/explain-why-a-single-profile-is-or-isnt-in-a-dynamic-group"}]},{"group":"Profile Group","pages":[{"openapi":"get /v3/profiles/{profile}/groups","title":"Group instances this profile owns","href":"/api-reference/profile-group/group-instances-this-profile-owns"},{"openapi":"post /v3/profiles/{profile}/groups","title":"Create (or return) this profile's instance of a definition","href":"/api-reference/profile-group/create-or-return-this-profiles-instance-of-a-definition"},{"openapi":"get /v3/profiles/{profile}/groups/{group}","title":null,"href":"/api-reference/profile-group/get-v3profiles-groups"},{"openapi":"delete /v3/profiles/{profile}/groups/{group}","title":null,"href":"/api-reference/profile-group/delete-v3profiles-groups"}]},{"group":"Group Member","pages":[{"openapi":"get /v3/profiles/{profile}/groups/{group}/profiles","title":"Browse Group Members","href":"/api-reference/group-member/get-v3profiles-groups-profiles"},{"openapi":"post /v3/profiles/{profile}/groups/{group}/profiles","title":"Add a Group Member","href":"/api-reference/group-member/post-v3profiles-groups-profiles"},{"openapi":"delete /v3/profiles/{profile}/groups/{group}/profiles/{target}","title":"Remove a Group Member","href":"/api-reference/group-member/delete-v3profiles-groups-profiles"},{"openapi":"post /v3/profiles/{profile}/groups/{group}/profiles","title":"Add a Group Member","href":"/api-reference/group-member/add-a-group-member"},{"openapi":"get /v3/profiles/{profile}/groups/{group}/profiles","title":"Browse Group Members","href":"/api-reference/group-member/browse-group-members"},{"openapi":"delete /v3/profiles/{profile}/groups/{group}/profiles/{target}","title":"Remove a Group Member","href":"/api-reference/group-member/remove-a-group-member"}]}]},{"group":"Ratings and Interactions","pages":[{"group":"Rating","pages":[{"openapi":"get /v3/ratings","title":"Browse Ratings","href":"/api-reference/rating/browse-ratings"},{"openapi":"post /v3/ratings","title":"Add Rating","href":"/api-reference/rating/add-rating"},{"openapi":"get /v3/ratings/{rating}","title":"Read Rating","href":"/api-reference/rating/read-rating"},{"openapi":"put /v3/ratings/{rating}","title":"Edit Rating","href":"/api-reference/rating/edit-rating"},{"openapi":"delete /v3/ratings/{rating}","title":"Delete Rating","href":"/api-reference/rating/delete-rating"}]},{"group":"Interaction","pages":[{"title":"Interactions","href":"/api-reference/interaction/overview"},{"openapi":"get /v3/interactions","title":"Browse Interactions","href":"/api-reference/interaction/browse-interactions"},{"openapi":"post /v3/interactions","title":"Add Interaction","href":"/api-reference/interaction/add-interaction"},{"openapi":"get /v3/interactions/{interaction}","title":"Read Interaction","href":"/api-reference/interaction/read-interaction"},{"openapi":"put /v3/interactions/{interaction}","title":"Edit Interaction","href":"/api-reference/interaction/edit-interaction"},{"openapi":"delete /v3/interactions/{interaction}","title":"Delete Interaction","href":"/api-reference/interaction/delete-interaction"}]},{"group":"Profile Interaction","pages":[{"title":"Profile Interactions","href":"/api-reference/profile-interaction/overview"},{"openapi":"get /v3/profiles/{profile}/interactions","title":"Browse Profile Interactions","href":"/api-reference/profile-interaction/browse-profile-interactions"},{"openapi":"get /v3/profiles/{profile}/interactions/{interaction}","title":"Read Profile Interaction","href":"/api-reference/profile-interaction/read-profile-interaction"},{"openapi":"delete /v3/profiles/{profile}/interactions/{interaction}","title":"Delete Profile Interaction","href":"/api-reference/profile-interaction/delete-profile-interaction"},{"openapi":"post /v3/profiles/{profile}/interactions","title":"Add Profile Interaction","href":"/api-reference/profile-interaction/add-profile-interaction"},{"openapi":"put /v3/profiles/{profile}/interactions/{interaction}","title":"Edit Profile Interaction","href":"/api-reference/profile-interaction/edit-profile-interaction"}]}]},{"group":"Reactions","pages":[{"group":"Trigger","pages":[{"title":"Triggers","href":"/api-reference/trigger/overview"},{"openapi":"get /v3/triggers","title":"Browse triggers","href":"/api-reference/trigger/browse-triggers"},{"openapi":"post /v3/triggers","title":"Add a trigger","href":"/api-reference/trigger/add-a-trigger"},{"openapi":"get /v3/triggers/{trigger}","title":"Read a trigger","href":"/api-reference/trigger/read-a-trigger"},{"openapi":"put /v3/triggers/{trigger}","title":"Edit Trigger","href":"/api-reference/trigger/edit-trigger"},{"openapi":"delete /v3/triggers/{trigger}","title":"Delete the trigger","href":"/api-reference/trigger/delete-the-trigger"},{"openapi":"post /v3/triggers/{trigger}/duplicate","title":"Duplicate a trigger","href":"/api-reference/trigger/duplicate-a-trigger"}]},{"group":"Trigger Action","pages":[{"openapi":"get /v3/triggers/{trigger}/actions","title":"Read trigger actions","href":"/api-reference/trigger-action/read-trigger-actions"},{"openapi":"post /v3/triggers/{trigger}/actions","title":"Add a trigger action","href":"/api-reference/trigger-action/add-a-trigger-action"},{"openapi":"get /v3/triggers/{trigger}/actions/{action}","title":"Read a specific trigger action","href":"/api-reference/trigger-action/read-a-specific-trigger-action"},{"openapi":"put /v3/triggers/{trigger}/actions/{action}","title":"Update an Trigger action","href":"/api-reference/trigger-action/update-an-trigger-action"},{"openapi":"delete /v3/triggers/{trigger}/actions/{action}","title":"Delete the trigger action","href":"/api-reference/trigger-action/delete-the-trigger-action"}]},{"group":"Automation","pages":[{"title":"Automations","href":"/api-reference/automation/overview"},{"openapi":"get /v3/automations","title":"Browse automations","href":"/api-reference/automation/browse-automations"},{"openapi":"post /v3/automations","title":"Add an automation","href":"/api-reference/automation/add-an-automation"},{"openapi":"get /v3/automations/{automation}","title":"Read an automation","href":"/api-reference/automation/read-an-automation"},{"openapi":"put /v3/automations/{automation}","title":"Edit an automation","href":"/api-reference/automation/edit-an-automation"},{"openapi":"delete /v3/automations/{automation}","title":"Delete the automation","href":"/api-reference/automation/delete-the-automation"},{"openapi":"post /v3/automations/{automation}/trigger","title":"Trigger Automation","href":"/api-reference/automation/trigger-automation"},{"openapi":"post /v3/automations/{automation}/duplicate","title":"Duplicate an automation","href":"/api-reference/automation/duplicate-an-automation"}]},{"group":"Automation Action","pages":[{"openapi":"get /v3/automations/{automation}/actions","title":"Read automation actions","href":"/api-reference/automation-action/read-automation-actions"},{"openapi":"post /v3/automations/{automation}/actions","title":"Add an automation action","href":"/api-reference/automation-action/add-an-automation-action"},{"openapi":"get /v3/automations/{automation}/actions/{action}","title":"Read a specific automation action","href":"/api-reference/automation-action/read-a-specific-automation-action"},{"openapi":"put /v3/automations/{automation}/actions/{action}","title":"Update an automation action","href":"/api-reference/automation-action/update-an-automation-action"},{"openapi":"delete /v3/automations/{automation}/actions/{action}","title":"Delete the automation action","href":"/api-reference/automation-action/delete-the-automation-action"}]},{"group":"Automation Query","pages":[{"openapi":"post /v3/automations/queries/samples","title":"Sample Automation Query Result","href":"/api-reference/automation-query/sample-automation-query-result"}]},{"group":"Automation Dry Run Result","pages":[{"title":"Automation dry run results","href":"/api-reference/automation-dry-run-result/overview"},{"openapi":"get /v3/automations/dry-run-results","title":"Browse Automation Dry Run Results","href":"/api-reference/automation-dry-run-result/browse-automation-dry-run-results"},{"openapi":"get /v3/automations/dry-run-results/{dryRunResult}","title":"Read Automation Dry Run Result","href":"/api-reference/automation-dry-run-result/read-automation-dry-run-result"},{"openapi":"delete /v3/automations/dry-run-results/{dryRunResult}","title":"Delete Automation Dry Run Result","href":"/api-reference/automation-dry-run-result/delete-automation-dry-run-result"}]},{"group":"Target","pages":[{"title":"Targets","href":"/api-reference/target/overview"},{"openapi":"get /v3/targets","title":"Browse Targets","href":"/api-reference/target/browse-targets"},{"openapi":"post /v3/targets","title":"Add a Target","href":"/api-reference/target/add-a-target"},{"openapi":"get /v3/targets/{target}","title":"Read a Target","href":"/api-reference/target/read-a-target"},{"openapi":"put /v3/targets/{target}","title":"Edit a Target","href":"/api-reference/target/edit-a-target"},{"openapi":"delete /v3/targets/{target}","title":"Delete the Target","href":"/api-reference/target/delete-the-target"},{"openapi":"post /v3/targets/preview","title":"Preview a Target Template","href":"/api-reference/target/preview-a-target-template"}]},{"group":"Webhook","pages":[{"openapi":"get /v3/webhooks","title":"Browse webhooks","href":"/api-reference/webhook/browse-webhooks"},{"openapi":"post /v3/webhooks","title":"Add a Webhook","href":"/api-reference/webhook/add-a-webhook"},{"openapi":"get /v3/webhooks/{webhook}","title":"Read a Webhook","href":"/api-reference/webhook/read-a-webhook"},{"openapi":"put /v3/webhooks/{webhook}","title":"Edit a Webhook","href":"/api-reference/webhook/edit-a-webhook"},{"openapi":"delete /v3/webhooks/{webhook}","title":"Delete the Webhook","href":"/api-reference/webhook/delete-the-webhook"},{"openapi":"post /v3/webhooks/batch.json","title":"Batch Webhooks","href":"/api-reference/webhook/batch-webhooks"}]}]},{"group":"Organisations and access","pages":[{"group":"Organisation","pages":[{"openapi":"get /v3/organisations","title":"List all organisations","href":"/api-reference/organisation/list-all-organisations"},{"openapi":"post /v3/organisations","title":"Add Organisation","href":"/api-reference/organisation/add-organisation"},{"openapi":"get /v3/organisations/{organisation}","title":"Read Organisation","href":"/api-reference/organisation/read-organisation"},{"openapi":"put /v3/organisations/{organisation}","title":"Edit Organisation","href":"/api-reference/organisation/edit-organisation"}]},{"group":"Organisation Profile","pages":[{"openapi":"get /v3/organisations/{organisation}/profiles","title":"Browse Organisation Profiles","href":"/api-reference/organisation-profile/browse-organisation-profiles"},{"openapi":"post /v3/organisations/{organisation}/profiles","title":"Add Organisation Profile","href":"/api-reference/organisation-profile/add-organisation-profile"},{"openapi":"delete /v3/organisations/{organisation}/profiles/{profile}","title":"Delete Organisation Profile","href":"/api-reference/organisation-profile/delete-organisation-profile"},{"openapi":"put /v3/organisations/{organisation}/profiles/{profile}","title":"Update Organisation Profile","href":"/api-reference/organisation-profile/update-organisation-profile"}]},{"group":"User","pages":[{"openapi":"get /v3/users/me","title":"Read the authenticated user","href":"/api-reference/user/read-the-authenticated-user"},{"openapi":"get /v3/users","title":"Browse users","href":"/api-reference/user/browse-users"},{"openapi":"post /v3/users","title":"Add a user","href":"/api-reference/user/add-a-user"},{"openapi":"get /v3/users/{user}","title":"Read a user","href":"/api-reference/user/read-a-user"},{"openapi":"put /v3/users/{user}","title":"Edit a user","href":"/api-reference/user/edit-a-user"},{"openapi":"delete /v3/users/{user}","title":"Delete the user","href":"/api-reference/user/delete-the-user"}]},{"group":"Staff","pages":[{"openapi":"post /v3/staff","title":"Add Staff Profile","href":"/api-reference/staff/add-staff-profile"},{"openapi":"put /v3/staff/{staff}","title":"Edit Staff Profile","href":"/api-reference/staff/edit-staff-profile"},{"openapi":"delete /v3/staff/{staff}","title":"Delete Staff Profile","href":"/api-reference/staff/delete-staff-profile"},{"openapi":"get /v3/staff/{handle}","title":"Read Staff","href":"/api-reference/staff/read-staff"}]},{"group":"Role","pages":[{"title":"Roles","href":"/api-reference/role/overview"},{"openapi":"get /v3/roles","title":"Browse Roles","href":"/api-reference/role/browse-roles"},{"openapi":"get /v3/roles/{role}","title":"Read Role","href":"/api-reference/role/read-role"}]},{"group":"Role Definition","pages":[{"openapi":"get /v3/roles/definitions","title":"List all role definitions","href":"/api-reference/role-definition/list-all-role-definitions"},{"openapi":"post /v3/roles/definitions","title":"Add Role Definition","href":"/api-reference/role-definition/add-role-definition"},{"openapi":"get /v3/roles/definitions/{definition}","title":"Read Role Definition","href":"/api-reference/role-definition/read-role-definition"},{"openapi":"put /v3/roles/definitions/{definition}","title":"Edit Role Definition","href":"/api-reference/role-definition/edit-role-definition"},{"openapi":"delete /v3/roles/definitions/{definition}","title":"Delete Role Definition","href":"/api-reference/role-definition/delete-role-definition"}]}]},{"group":"Configuration","pages":[{"group":"Connection","pages":[{"openapi":"get /v3/connections","title":"Browse Connections","href":"/api-reference/connection/browse-connections"},{"openapi":"post /v3/connections","title":"Add Connection","href":"/api-reference/connection/add-connection"},{"openapi":"get /v3/connections/{connection}","title":"Read A Connection","href":"/api-reference/connection/read-a-connection"},{"openapi":"put /v3/connections/{connection}","title":"Edit Connection","href":"/api-reference/connection/edit-connection"},{"openapi":"delete /v3/connections/{connection}","title":"Delete Connection","href":"/api-reference/connection/delete-connection"}]},{"group":"Connection Definition","pages":[{"openapi":"get /v3/connection/definitions","title":"Browse Connection Definitions","href":"/api-reference/connection-definition/browse-connection-definitions"},{"openapi":"post /v3/connection/definitions","title":"Add Connection Definition","href":"/api-reference/connection-definition/add-connection-definition"},{"openapi":"get /v3/connection/definitions/{definition}","title":"Read Connection Definition","href":"/api-reference/connection-definition/read-connection-definition"},{"openapi":"put /v3/connection/definitions/{definition}","title":"Edit Connection Definition","href":"/api-reference/connection-definition/edit-connection-definition"},{"openapi":"delete /v3/connection/definitions/{definition}","title":"Delete Connection Definition","href":"/api-reference/connection-definition/delete-connection-definition"}]},{"group":"Connection Custom Field","pages":[{"openapi":"get /v3/connections/{connection}/custom-fields","title":"Browse Connection Custom Fields","href":"/api-reference/connection-custom-field/browse-connection-custom-fields"},{"openapi":"post /v3/connections/{connection}/custom-fields","title":"Add Connection Custom Field","href":"/api-reference/connection-custom-field/add-connection-custom-field"},{"openapi":"get /v3/connections/{connection}/custom-fields/{customField}","title":"Read Connection Custom Field","href":"/api-reference/connection-custom-field/read-connection-custom-field"},{"openapi":"put /v3/connections/{connection}/custom-fields/{customField}","title":"Edit Connection Custom Field","href":"/api-reference/connection-custom-field/edit-connection-custom-field"},{"openapi":"delete /v3/connections/{connection}/custom-fields/{customField}","title":"Delete Connection Custom Field","href":"/api-reference/connection-custom-field/delete-connection-custom-field"}]},{"group":"Status","pages":[{"title":"Statuses","href":"/api-reference/status/overview"},{"openapi":"get /v3/statuses","title":"Browse Statuses","href":"/api-reference/status/browse-statuses"},{"openapi":"post /v3/statuses","title":"Add Status","href":"/api-reference/status/add-status"},{"openapi":"get /v3/statuses/{status}","title":"Read Status","href":"/api-reference/status/read-status"},{"openapi":"put /v3/statuses/{status}","title":"Edit Status","href":"/api-reference/status/edit-status"},{"openapi":"delete /v3/statuses/{status}","title":"Delete Status","href":"/api-reference/status/delete-status"}]},{"group":"Tag","pages":[{"openapi":"get /v3/tags","title":"Browse Tags","href":"/api-reference/tag/browse-tags"},{"openapi":"post /v3/tags","title":"Add Tag","href":"/api-reference/tag/add-tag"},{"openapi":"get /v3/tags/{tag}","title":"Read Tag","href":"/api-reference/tag/read-tag"},{"openapi":"delete /v3/tags/{tag}","title":"Delete Tag","href":"/api-reference/tag/delete-tag"}]},{"group":"Custom Field","pages":[{"openapi":"get /v3/custom-fields/{model}/{id}","title":"Browse Custom Fields","href":"/api-reference/custom-field/browse-custom-fields"},{"openapi":"post /v3/custom-fields/{model}/{id}","title":"Add Custom Field","href":"/api-reference/custom-field/add-custom-field"},{"openapi":"get /v3/custom-fields/search","title":"Search Custom Fields","href":"/api-reference/custom-field/search-custom-fields"},{"openapi":"delete /v3/custom-fields/{model}/{id}/batchJsonDelete","title":"Batch Delete Custom Fields","href":"/api-reference/custom-field/batch-delete-custom-fields"},{"openapi":"delete /v3/custom-fields/{model}/{id}/{customField}","title":"Delete Custom Field","href":"/api-reference/custom-field/delete-custom-field"}]},{"group":"Saved Filter","pages":[{"openapi":"get /v3/{modelType}/savedfilter","title":"Browse Saved Filters","href":"/api-reference/saved-filter/browse-saved-filters"},{"openapi":"post /v3/{modelType}/savedfilter","title":"Add Saved Filter","href":"/api-reference/saved-filter/add-saved-filter"},{"openapi":"put /v3/{modelType}/savedfilter/{savedFilter}","title":"Edit Saved Filter","href":"/api-reference/saved-filter/edit-saved-filter"},{"openapi":"delete /v3/{modelType}/savedfilter/{savedFilter}","title":"Delete Saved Filter","href":"/api-reference/saved-filter/delete-saved-filter"}]},{"group":"Rate","pages":[{"openapi":"get /v3/rates","title":"Browse Rates","href":"/api-reference/rate/browse-rates"},{"openapi":"post /v3/rates","title":"Add Rate","href":"/api-reference/rate/add-rate"},{"openapi":"get /v3/rates/{rate}","title":"Read Rate","href":"/api-reference/rate/read-rate"},{"openapi":"put /v3/rates/{rate}","title":"Edit Rate","href":"/api-reference/rate/edit-rate"},{"openapi":"delete /v3/rates/{rate}","title":"Delete Rate","href":"/api-reference/rate/delete-rate"},{"openapi":"post /v3/rates/calculate","title":"Calculate Rate","href":"/api-reference/rate/calculate-rate"},{"openapi":"get /v3/rates/product-estimate","title":"Estimate Rate For Product","href":"/api-reference/rate/estimate-rate-for-product"},{"openapi":"get /v3/rates/product-variant-estimate","title":"Estimate Rate For Product Variant","href":"/api-reference/rate/estimate-rate-for-product-variant"},{"openapi":"get /v3/rates/searchAttributes/{attribute}","title":"Search Rates by Attribute","href":"/api-reference/rate/search-rates-by-attribute"}]},{"group":"Brand","pages":[{"openapi":"get /v3/brands","title":"Browse Brands","href":"/api-reference/brand/browse-brands"},{"openapi":"post /v3/brands","title":"Add Brand","href":"/api-reference/brand/add-brand"},{"openapi":"get /v3/brands/{brand}","title":"Read Brand","href":"/api-reference/brand/read-brand"},{"openapi":"put /v3/brands/{brand}","title":"Edit Brand","href":"/api-reference/brand/edit-brand"},{"openapi":"delete /v3/brands/{brand}","title":"Delete Brand","href":"/api-reference/brand/delete-brand"}]},{"group":"Region","pages":[{"openapi":"get /v3/regions","title":"Browse Regions","href":"/api-reference/region/browse-regions"},{"openapi":"post /v3/regions","title":"Add Region","href":"/api-reference/region/add-region"},{"openapi":"get /v3/regions/{region}","title":"Read Region","href":"/api-reference/region/read-region"},{"openapi":"put /v3/regions/{region}","title":"Edit Region","href":"/api-reference/region/edit-region"},{"openapi":"delete /v3/regions/{region}","title":"Delete Region","href":"/api-reference/region/delete-region"}]},{"group":"Country","pages":[{"openapi":"get /v3/countries","title":"Browse Countries","href":"/api-reference/country/browse-countries"},{"openapi":"post /v3/countries","title":"Add Country","href":"/api-reference/country/add-country"},{"openapi":"get /v3/countries/{country}","title":"Read Country","href":"/api-reference/country/read-country"},{"openapi":"put /v3/countries/{country}","title":"Edit Country","href":"/api-reference/country/edit-country"},{"openapi":"delete /v3/countries/{country}","title":"Delete Country","href":"/api-reference/country/delete-country"}]},{"group":"Currency","pages":[{"openapi":"get /v3/currencies","title":"Browse Currencies","href":"/api-reference/currency/browse-currencies"},{"openapi":"post /v3/currencies","title":"Add Currency","href":"/api-reference/currency/add-currency"},{"openapi":"get /v3/currencies/{currency}","title":"Read Currency","href":"/api-reference/currency/read-currency"},{"openapi":"put /v3/currencies/{currency}","title":"Edit Currency","href":"/api-reference/currency/edit-currency"},{"openapi":"delete /v3/currencies/{currency}","title":"Delete Currency","description":"A `DELETE` to the `/currencies/{currency}` endpoint allows your application to delete currency.","href":"/api-reference/currency/delete-currency"},{"openapi":"post /v3/currencies/batch.json","title":"Add Market Rates","href":"/api-reference/currency/add-market-rates"}]},{"group":"Department","pages":[{"openapi":"get /v3/departments","title":"Browse Departments","description":"A `GET` to the `/departments` endpoint allows your application to retrieve departments.","href":"/api-reference/department/browse-departments"},{"openapi":"post /v3/departments","title":"Add Department","href":"/api-reference/department/add-department"},{"openapi":"get /v3/departments/{department}","title":"Read Department","href":"/api-reference/department/read-department"},{"openapi":"put /v3/departments/{department}","title":"Edit Department","href":"/api-reference/department/edit-department"},{"openapi":"delete /v3/departments/{department}","title":"Delete Department","href":"/api-reference/department/delete-department"}]},{"group":"System","pages":[{"openapi":"get /v3/systems","title":"Browse Systems","href":"/api-reference/system/browse-systems"},{"openapi":"post /v3/systems","title":"Add System","href":"/api-reference/system/add-system"},{"openapi":"get /v3/systems/{system}","title":"Read System","href":"/api-reference/system/read-system"},{"openapi":"delete /v3/systems/{system}","title":"Delete System","href":"/api-reference/system/delete-system"}]},{"group":"Question Custom Field","pages":[{"openapi":"post /v3/questions/{question}/custom-fields","title":"Add Question Custom Field","href":"/api-reference/question-custom-field/add-question-custom-field"},{"openapi":"get /v3/questions/{question}/custom-fields","title":"Browse Question Custom Fields","href":"/api-reference/question-custom-field/browse-question-custom-fields"},{"openapi":"delete /v3/questions/{question}/custom-fields/{customField}","title":"Delete Question Custom Field","href":"/api-reference/question-custom-field/delete-question-custom-field"},{"openapi":"put /v3/questions/{question}/custom-fields/{customField}","title":"Edit Question Custom Field","href":"/api-reference/question-custom-field/edit-question-custom-field"},{"openapi":"get /v3/questions/{question}/custom-fields/{customField}","title":"Read Question Custom Field","href":"/api-reference/question-custom-field/read-question-custom-field"}]},{"group":"Questionnaire Custom Field","pages":[{"openapi":"post /v3/questionnaires/{questionnaire}/custom-fields","title":"Add Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/add-questionnaire-custom-field"},{"openapi":"get /v3/questionnaires/{questionnaire}/custom-fields","title":"Browse Questionnaire Custom Fields","href":"/api-reference/questionnaire-custom-field/browse-questionnaire-custom-fields"},{"openapi":"delete /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Delete Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/delete-questionnaire-custom-field"},{"openapi":"put /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Edit Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/edit-questionnaire-custom-field"},{"openapi":"get /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Read Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/read-questionnaire-custom-field"}]}]},{"group":"Platform","pages":[{"group":"Import","pages":[{"openapi":"get /v3/imports","title":"Browse Imports","href":"/api-reference/import/browse-imports"},{"openapi":"post /v3/imports/manual","title":"Create Manual Import","href":"/api-reference/import/create-manual-import"},{"openapi":"get /v3/imports/{import}","title":"Read Import","href":"/api-reference/import/read-import"},{"openapi":"post /v3/imports","title":"Upload Import","href":"/api-reference/import/upload-import"},{"openapi":"post /v3/imports/file","title":"Upload Import Mapping File","href":"/api-reference/import/upload-import-mapping-file"},{"openapi":"delete /v3/imports/{import}","title":"Delete Import","href":"/api-reference/import/delete-import"},{"openapi":"post /v3/imports/condition","title":"Browse Conditional Imports","href":"/api-reference/import/browse-conditional-imports"}]},{"group":"Import Job","pages":[{"openapi":"get /v3/imports/{import}/jobs","title":"Browse Import Jobs","href":"/api-reference/import-job/browse-import-jobs"},{"openapi":"post /v3/imports/{import}/jobs","title":"Add Import Job","href":"/api-reference/import-job/add-import-job"},{"openapi":"get /v3/imports/{import}/jobs/{job}","title":"Read Import Job","href":"/api-reference/import-job/read-import-job"},{"openapi":"post /v3/imports/{import}/jobs/{job}/finalize","title":"Finalize Import Job","href":"/api-reference/import-job/finalize-import-job"},{"openapi":"post /v3/imports/{import}/jobs/export","title":"Export Import Jobs","href":"/api-reference/import-job/export-import-jobs"},{"openapi":"post /v3/imports/{import}/jobs/batch.json","title":"Batch Import Jobs","href":"/api-reference/import-job/batch-import-jobs"}]},{"group":"Import Failure","pages":[{"openapi":"get /v3/imports/{import}/failures","title":"Browse Import Failures","href":"/api-reference/import-failure/browse-import-failures"},{"openapi":"post /v3/imports/{import}/failures/export","title":"Export Import Failures","href":"/api-reference/import-failure/export-import-failures"}]},{"group":"Batch","pages":[{"openapi":"get /v3/batches","title":"Browse Batches","href":"/api-reference/batch/browse-batches"},{"openapi":"post /v3/batches","title":"Add Batch","href":"/api-reference/batch/add-batch"},{"openapi":"get /v3/batches/{batch}","title":"Read Batch","href":"/api-reference/batch/read-batch"},{"openapi":"post /v3/batches/{batch}/items","title":"Add Batch Items","href":"/api-reference/batch/add-batch-items"}]},{"group":"Ledger","pages":[{"openapi":"get /v3/profiles/{profile}/ledgers","title":"Browse Ledgers","href":"/api-reference/ledger/browse-ledgers"},{"openapi":"get /v3/profiles/{profile}/ledgers/{ledger}","title":"Read Ledger","href":"/api-reference/ledger/read-ledger"}]},{"group":"Action History","pages":[{"openapi":"get /v3/action-history","title":"Browse Action Histories","href":"/api-reference/action-history/browse-action-histories"},{"openapi":"get /v3/action-history/{actionHistory}","title":"Read Action History","href":"/api-reference/action-history/read-action-history"}]},{"group":"Audit","pages":[{"title":"Audits","href":"/api-reference/audit/overview"},{"openapi":"get /v3/audits","title":"Browse Audits","href":"/api-reference/audit/browse-audits"},{"openapi":"post /v3/audits","title":"Create audit","href":"/api-reference/audit/create-audit"},{"openapi":"get /v3/audits/{audit}","title":"Read an Audit","href":"/api-reference/audit/read-an-audit"},{"openapi":"put /v3/audits/{audit}","title":"Update audit","href":"/api-reference/audit/update-audit"}]},{"group":"Setting","pages":[{"openapi":"get /v3/settings/environment","title":"Read Environment Settings","href":"/api-reference/setting/read-environment-settings"},{"openapi":"get /v3/settings","title":"Browse settings","href":"/api-reference/setting/browse-settings"},{"openapi":"post /v3/settings","title":"Add Setting","href":"/api-reference/setting/add-setting"},{"openapi":"get /v3/settings/{setting}","title":"Read a Setting","href":"/api-reference/setting/read-a-setting"},{"openapi":"put /v3/settings/{setting}","title":"Edit a setting","href":"/api-reference/setting/edit-a-setting"},{"openapi":"delete /v3/settings/{setting}","title":"Delete the setting","href":"/api-reference/setting/delete-the-setting"}]},{"group":"Tenant","pages":[{"openapi":"post /v3/tenants/custom-event","title":"Trigger Tenant Custom Event","href":"/api-reference/tenant/trigger-tenant-custom-event"}]},{"group":"Tenant Custom Field","pages":[{"openapi":"get /v3/tenants/custom-fields","title":"Browse Tenant Custom Fields","href":"/api-reference/tenant-custom-field/browse-tenant-custom-fields"},{"openapi":"post /v3/tenants/custom-fields","title":"Add Tenant Custom Field","href":"/api-reference/tenant-custom-field/add-tenant-custom-field"},{"openapi":"get /v3/tenants/custom-fields/{customField}","title":"Read Tenant Custom Field","href":"/api-reference/tenant-custom-field/read-tenant-custom-field"},{"openapi":"put /v3/tenants/custom-fields/{customField}","title":"Edit Tenant Custom Field","href":"/api-reference/tenant-custom-field/edit-tenant-custom-field"},{"openapi":"delete /v3/tenants/custom-fields/{customField}","title":"Delete Tenant Custom Field","href":"/api-reference/tenant-custom-field/delete-tenant-custom-field"}]},{"group":"Reminder","pages":[{"openapi":"get /v3/reminders","title":"Browse Reminders","href":"/api-reference/reminder/browse-reminders"},{"openapi":"post /v3/reminders","title":"Add Reminder","href":"/api-reference/reminder/add-reminder"},{"openapi":"get /v3/reminders/{reminder}","title":"Read Reminder","href":"/api-reference/reminder/read-reminder"},{"openapi":"put /v3/reminders/{reminder}","title":"Edit Reminder","href":"/api-reference/reminder/edit-reminder"},{"openapi":"delete /v3/reminders/{reminder}","title":"Delete Reminder","href":"/api-reference/reminder/delete-reminder"}]},{"group":"Health","pages":[{"openapi":"get /health","title":"Read Health","href":"/api-reference/health/read-health"}]}]},{"group":"Questionnaires","pages":[{"group":"Question","pages":[{"openapi":"post /v3/questions","title":"Add Question","href":"/api-reference/question/add-question"},{"openapi":"get /v3/questions","title":"Browse Questions","href":"/api-reference/question/browse-questions"},{"openapi":"delete /v3/questions/{question}","title":"Delete Question","href":"/api-reference/question/delete-question"},{"openapi":"get /v3/questions/{question}","title":"Read Question","href":"/api-reference/question/read-question"},{"openapi":"put /v3/questions/{question}","title":"Update Question","href":"/api-reference/question/update-question"}]},{"group":"Question Custom Field","pages":[{"openapi":"post /v3/questions/{question}/custom-fields","title":"Add Question Custom Field","href":"/api-reference/question-custom-field/add-question-custom-field"},{"openapi":"get /v3/questions/{question}/custom-fields","title":"Browse Question Custom Fields","href":"/api-reference/question-custom-field/browse-question-custom-fields"},{"openapi":"delete /v3/questions/{question}/custom-fields/{customField}","title":"Delete Question Custom Field","href":"/api-reference/question-custom-field/delete-question-custom-field"},{"openapi":"put /v3/questions/{question}/custom-fields/{customField}","title":"Edit Question Custom Field","href":"/api-reference/question-custom-field/edit-question-custom-field"},{"openapi":"get /v3/questions/{question}/custom-fields/{customField}","title":"Read Question Custom Field","href":"/api-reference/question-custom-field/read-question-custom-field"}]},{"group":"Questionnaire","pages":[{"openapi":"post /v3/questionnaires","title":"Add Questionnaire","href":"/api-reference/questionnaire/add-questionnaire"},{"openapi":"get /v3/questionnaires","title":"Browse Questionnaires","href":"/api-reference/questionnaire/browse-questionnaires"},{"openapi":"delete /v3/questionnaires/{questionnaire}","title":"Delete Questionnaire","href":"/api-reference/questionnaire/delete-questionnaire"},{"openapi":"get /v3/questionnaires/{questionnaire}","title":"Read Questionnaire","href":"/api-reference/questionnaire/read-questionnaire"},{"openapi":"put /v3/questionnaires/{questionnaire}","title":"Update Questionnaire","href":"/api-reference/questionnaire/update-questionnaire"}]},{"group":"Questionnaire Page","pages":[{"openapi":"post /v3/questionnaires/{questionnaire}/pages","title":"Add Questionnaire Page","href":"/api-reference/questionnaire-page/add-questionnaire-page"},{"openapi":"get /v3/questionnaires/{questionnaire}/pages","title":"Browse Questionnaire Pages","href":"/api-reference/questionnaire-page/browse-questionnaire-pages"},{"openapi":"delete /v3/questionnaires/{questionnaire}/pages/{page}","title":"Delete Questionnaire Page","href":"/api-reference/questionnaire-page/delete-questionnaire-page"},{"openapi":"get /v3/questionnaires/{questionnaire}/pages/{page}","title":"Read Questionnaire Page","href":"/api-reference/questionnaire-page/read-questionnaire-page"},{"openapi":"put /v3/questionnaires/{questionnaire}/pages/{page}","title":"Update Questionnaire Page","href":"/api-reference/questionnaire-page/update-questionnaire-page"}]},{"group":"Questionnaire Question","pages":[{"openapi":"post /v3/questionnaires/{questionnaire}/questions","title":"Add Questionnaire Question","href":"/api-reference/questionnaire-question/add-questionnaire-question"},{"openapi":"get /v3/questionnaires/{questionnaire}/questions","title":"Browse Questionnaire Questions","href":"/api-reference/questionnaire-question/browse-questionnaire-questions"},{"openapi":"delete /v3/questionnaires/{questionnaire}/questions/{question}","title":"Delete Questionnaire Question","href":"/api-reference/questionnaire-question/delete-questionnaire-question"},{"openapi":"get /v3/questionnaires/{questionnaire}/questions/{question}","title":"Read Questionnaire Question","href":"/api-reference/questionnaire-question/read-questionnaire-question"},{"openapi":"put /v3/questionnaires/{questionnaire}/questions/{question}","title":"Update Questionnaire Question","href":"/api-reference/questionnaire-question/update-questionnaire-question"}]},{"group":"Questionnaire Custom Field","pages":[{"openapi":"post /v3/questionnaires/{questionnaire}/custom-fields","title":"Add Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/add-questionnaire-custom-field"},{"openapi":"get /v3/questionnaires/{questionnaire}/custom-fields","title":"Browse Questionnaire Custom Fields","href":"/api-reference/questionnaire-custom-field/browse-questionnaire-custom-fields"},{"openapi":"delete /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Delete Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/delete-questionnaire-custom-field"},{"openapi":"put /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Edit Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/edit-questionnaire-custom-field"},{"openapi":"get /v3/questionnaires/{questionnaire}/custom-fields/{customField}","title":"Read Questionnaire Custom Field","href":"/api-reference/questionnaire-custom-field/read-questionnaire-custom-field"}]},{"group":"Questionnaire Submission","pages":[{"openapi":"post /v3/questionnaires/{questionnaire}/submissions","title":"Submit Questionnaire","href":"/api-reference/questionnaire-submission/submit-questionnaire"}]}]}]}]},"title":"Add Market Rates - Omneo API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}