{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Shortext","description":"Shortext runs AI agents on WhatsApp, mailboxes and your own apps. Guides for the dashboard and reference for the public API.","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/n-ycorp/BNyO30yvo2XGv-Dr/logo/light.svg?fit=max\u0026auto=format\u0026n=BNyO30yvo2XGv-Dr\u0026q=85\u0026s=321a01994cf59d9ab14c6c2d24145600","dark":"https://mintcdn.com/n-ycorp/BNyO30yvo2XGv-Dr/logo/dark.svg?fit=max\u0026auto=format\u0026n=BNyO30yvo2XGv-Dr\u0026q=85\u0026s=843f5c81fdc5017f4e38c4f911ceafab"},"favicon":"https://mintcdn.com/n-ycorp/_ZaOYbkIIjdke_qI/favicon.svg?fit=max\u0026auto=format\u0026n=_ZaOYbkIIjdke_qI\u0026q=85\u0026s=d2cab565aeda8ce75e889830398d7127","api":{"openapi":"api-reference/v2.0/openapi.json","playground":{"display":"interactive"},"examples":{"languages":["curl","php","javascript","python"]}},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:hello@ny-corp.io","label":"Mail us"},{"href":"https://shortext.ny-corp.io/237657482849","label":"WhatsApp us"}],"primary":{"type":"button","label":"Dashboard","href":"https://shortext.ny-corp.io/dash"}},"footer":{"socials":{"website":"https://shortext.ny-corp.io","github":"https://github.com/yann-yvan/shortext-sdk-php","linkedin":"https://www.linkedin.com/showcase/shortext","facebook":"https://facebook.com/shortext"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://shortext.ny-corp.io/community"},{"anchor":"Blog","icon":"newspaper","href":"https://shortext.ny-corp.io/blogs"}]},"languages":[{"language":"en","default":true,"href":"introduction/what-is-shortext"},{"language":"fr","href":"fr/introduction/what-is-shortext"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"n-ycorp","hasAudioNarration":false,"actualSubdomain":"n-ycorp","customDomains":["docs.shortext.ny-corp.io"],"gitSource":{"type":"github","owner":"yann-yvan","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adefad6374824585d6a1f3d","collectionId":"79668335-9191-42bb-91dd-560e52859754","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adefad6374824585d6a1f3d"},"entitlements":{},"buildId":"6adefad6374824585d6a1f3d","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"en","tag":"API Reference","count":149},{"language":"fr","tag":"Référence API","count":149},{"language":"en","tag":"Endpoints","count":124},{"language":"fr","tag":"Endpoints","count":124},{"language":"en","tag":"Guides","count":27},{"language":"fr","tag":"Guides","count":27},{"language":"en","tag":"Tickets","count":20},{"language":"fr","tag":"Tickets","count":20},{"language":"en","tag":"Campaigns","count":19},{"language":"fr","tag":"Campaigns","count":19},{"language":"en","tag":"Channels","count":14},{"language":"en","tag":"Knowledge","count":12},{"language":"en","tag":"Dynamic links","count":12},{"language":"fr","tag":"Knowledge","count":12},{"language":"fr","tag":"Dynamic links","count":12},{"language":"en","tag":"Follow-ups","count":11},{"language":"fr","tag":"Follow-ups","count":11},{"language":"en","tag":"Webhooks","count":10},{"language":"fr","tag":"Webhooks","count":10},{"language":"fr","tag":"Agents","count":9}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","slug":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","pageMetadata":{"title":"List campaigns","description":"Most recent first, 50 per page. Filter with `status` and `name`.","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns","href":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Most recent first, 50 per page. Filter with \", _jsx(_components.code, {\n children: \"status\"\n }), \" and \", _jsx(_components.code, {\n children: \"name\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List campaigns","description":"Most recent first, 50 per page. Filter with `status` and `name`.","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns","href":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Campaigns"],"summary":"List campaigns","description":"Most recent first, 50 per page. Filter with `status` and `name`.","operationId":"listCampaigns","parameters":["d11cb303-816a-4424-aec4-58a95d44c015","e8a6f66e-8baa-403b-882e-870db25c5973","f23c7f14-8525-4c6d-8890-7ffce15477d0"],"responses":{"200":"fc428294-96e8-435e-9918-6bcc802732ff"},"security":["ba1f8804-0f49-46e3-b98c-55b4c7e7097f"],"method":"get","type":"path","servers":["ce0e6bef-eb4b-4888-8613-d24793f6b92b"],"path":"/campaigns","baseUrlOptions":["https://shortext.ny-corp.io/api/v2.0"],"title":"List campaigns","codeSamples":[],"requestExampleLanguages":["bash","php","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d11cb303-816a-4424-aec4-58a95d44c015":{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","scheduled","active","paused","ended","failed"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"e8a6f66e-8baa-403b-882e-870db25c5973":{"name":"name","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"f23c7f14-8525-4c6d-8890-7ffce15477d0":{"name":"page","in":"query","required":false,"schema":{"type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"fc428294-96e8-435e-9918-6bcc802732ff":{"description":"Always HTTP 200: the outcome is in `success` and `code` (absolute value of the response code).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"integer","example":1000,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","example":"Request success.","uniqueKey":"message","typeLabel":"string"},"body":{"type":"object","description":"A page of results: `data` holds the items. Ask another page with `?page=`","properties":{"current_page":{"type":"integer","example":1,"uniqueKey":"body.current_page","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Public representation of campaigns, their contact files and segments (API v2.0)","type":"string","example":"CMP-XXXXX","uniqueKey":"body.data.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"body.data.items.[INDEX].name","typeLabel":"string"},"category":{"type":"string","enum":["marketing","transactional","specialized"],"uniqueKey":"body.data.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"objective":{"oneOf":[{"type":"string","uniqueKey":"body.data.items.[INDEX].objective.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.data.items.[INDEX].objective.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].objective","typeLabel":"string | null"},"trigger":{"description":"`scheduled`: sent once to an audience. `new_conversation`: sent on each new conversation while active.","type":"string","enum":["scheduled","new_conversation"],"uniqueKey":"body.data.items.[INDEX].trigger","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["draft","scheduled","active","paused","ended","failed"],"uniqueKey":"body.data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"failure_reason":{"oneOf":[{"type":"string","uniqueKey":"body.data.items.[INDEX].failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.data.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].failure_reason","typeLabel":"string | null"},"once_per_contact":{"oneOf":[{"description":"Automatic campaigns: a contact gets the message once","type":"boolean","uniqueKey":"body.data.items.[INDEX].once_per_contact.oneOf.0","typeLabel":"boolean"},{"description":"Automatic campaigns: a contact gets the message once","type":"null","uniqueKey":"body.data.items.[INDEX].once_per_contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].once_per_contact","typeLabel":"boolean | null"},"channels":{"type":"array","items":{"properties":{"channel":{"type":"string","enum":["whatsapp","mail"],"uniqueKey":"body.data.items.[INDEX].channels.items.[INDEX].channel","typeLabel":"enum\u003cstring>"},"channel_id":{"description":"The sender: WhatsApp phone number id or mailbox id (mbx_...)","type":"string","uniqueKey":"body.data.items.[INDEX].channels.items.[INDEX].channel_id","typeLabel":"string"}},"type":"object","uniqueKey":"body.data.items.[INDEX].channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.data.items.[INDEX].channels","typeLabel":"object[]"},"messages":{"description":"One message per channel, by channel","type":"object","example":{"whatsapp":{"type":"template","template":{"id":"TPL-XXXXX","name":"promo","language":"fr"},"variables":{"name":{"source":"field:firstname","fallback":"client"}},"buttons":["promo-@firstname"]},"mail":{"type":"email","subject":"Our offer, @{firstname|dear customer}"}},"uniqueKey":"body.data.items.[INDEX].messages","typeLabel":"object"},"audience":{"properties":{"source":{"type":"string","enum":["segment","file","contacts"],"uniqueKey":"body.data.items.[INDEX].audience.source","typeLabel":"enum\u003cstring>"},"segment_id":{"oneOf":[{"type":"string","uniqueKey":"body.data.items.[INDEX].audience.segment_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.data.items.[INDEX].audience.segment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].audience.segment_id","typeLabel":"string | null"},"import_id":{"oneOf":[{"type":"string","uniqueKey":"body.data.items.[INDEX].audience.import_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.data.items.[INDEX].audience.import_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].audience.import_id","typeLabel":"string | null"},"recipients":{"description":"Recipients written to the campaign (a segment is evaluated when it starts)","type":"integer","uniqueKey":"body.data.items.[INDEX].audience.recipients","typeLabel":"integer"}},"type":"object","uniqueKey":"body.data.items.[INDEX].audience","typeLabel":"object"},"start_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"body.data.items.[INDEX].start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"body.data.items.[INDEX].start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].start_at","typeLabel":"string\u003cdate-time> | null"},"end_at":{"oneOf":[{"description":"Replies count for the campaign until this date","type":"string","format":"date-time","uniqueKey":"body.data.items.[INDEX].end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Replies count for the campaign until this date","type":"null","format":"date-time","uniqueKey":"body.data.items.[INDEX].end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].end_at","typeLabel":"string\u003cdate-time> | null"},"send_window":{"oneOf":[{"description":"Hours of the day it may send, in the company time zone","properties":{"start":{"type":"string","example":"08:00","uniqueKey":"body.data.items.[INDEX].send_window.oneOf.0.start","typeLabel":"string"},"end":{"type":"string","example":"20:00","uniqueKey":"body.data.items.[INDEX].send_window.oneOf.0.end","typeLabel":"string"}},"type":"object","uniqueKey":"body.data.items.[INDEX].send_window.oneOf.0","typeLabel":"object"},{"description":"Hours of the day it may send, in the company time zone","properties":{"start":{"type":"string","example":"08:00"},"end":{"type":"string","example":"20:00"}},"type":"null","uniqueKey":"body.data.items.[INDEX].send_window.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].send_window","typeLabel":"object | null"},"follow_up_intention_ids":{"type":"array","items":{"type":"string","uniqueKey":"body.data.items.[INDEX].follow_up_intention_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"body.data.items.[INDEX].follow_up_intention_ids","typeLabel":"string[]"},"paused_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"body.data.items.[INDEX].paused_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"body.data.items.[INDEX].paused_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].paused_at","typeLabel":"string\u003cdate-time> | null"},"duplicated_from":{"oneOf":[{"type":"string","uniqueKey":"body.data.items.[INDEX].duplicated_from.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.data.items.[INDEX].duplicated_from.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.data.items.[INDEX].duplicated_from","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"body.data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"body.data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"body.data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.data","typeLabel":"object[]"},"per_page":{"type":"integer","example":50,"uniqueKey":"body.per_page","typeLabel":"integer"},"total":{"type":"integer","example":120,"uniqueKey":"body.total","typeLabel":"integer"},"last_page":{"type":"integer","example":3,"uniqueKey":"body.last_page","typeLabel":"integer"},"from":{"oneOf":[{"type":"integer","uniqueKey":"body.from.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"body.from.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.from","typeLabel":"integer | null"},"to":{"oneOf":[{"type":"integer","uniqueKey":"body.to.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"body.to.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.to","typeLabel":"integer | null"},"first_page_url":{"type":"string","uniqueKey":"body.first_page_url","typeLabel":"string"},"last_page_url":{"type":"string","uniqueKey":"body.last_page_url","typeLabel":"string"},"next_page_url":{"oneOf":[{"type":"string","uniqueKey":"body.next_page_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.next_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.next_page_url","typeLabel":"string | null"},"prev_page_url":{"oneOf":[{"type":"string","uniqueKey":"body.prev_page_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"body.prev_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"body.prev_page_url","typeLabel":"string | null"},"path":{"type":"string","uniqueKey":"body.path","typeLabel":"string"}},"uniqueKey":"body","typeLabel":"object"},"token":{"oneOf":[{"description":"Present only on authentication routes","type":"string","uniqueKey":"token.oneOf.0","typeLabel":"string"},{"description":"Present only on authentication routes","type":"null","uniqueKey":"token.oneOf.1","typeLabel":"null"}],"uniqueKey":"token","typeLabel":"string | null"},"trace_id":{"oneOf":[{"description":"Present only when success is false","type":"string","uniqueKey":"trace_id.oneOf.0","typeLabel":"string"},{"description":"Present only when success is false","type":"null","uniqueKey":"trace_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"trace_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"code":1000,"message":"Request success.","body":{"current_page":1,"data":[{"id":"CMP-XXXXX","name":"\u003cstring>","category":"marketing","objective":"\u003cstring>","trigger":"scheduled","status":"draft","failure_reason":"\u003cstring>","once_per_contact":true,"channels":[{"channel":"whatsapp","channel_id":"\u003cstring>"}],"messages":{"whatsapp":{"type":"template","template":{"id":"TPL-XXXXX","name":"promo","language":"fr"},"variables":{"name":{"source":"field:firstname","fallback":"client"}},"buttons":["promo-@firstname"]},"mail":{"type":"email","subject":"Our offer, @{firstname|dear customer}"}},"audience":{"source":"segment","segment_id":"\u003cstring>","import_id":"\u003cstring>","recipients":123},"start_at":"2023-11-07T05:31:56Z","end_at":"2023-11-07T05:31:56Z","send_window":{"start":"08:00","end":"20:00"},"follow_up_intention_ids":["\u003cstring>"],"paused_at":"2023-11-07T05:31:56Z","duplicated_from":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"per_page":50,"total":120,"last_page":3,"from":123,"to":123,"first_page_url":"\u003cstring>","last_page_url":"\u003cstring>","next_page_url":"\u003cstring>","prev_page_url":"\u003cstring>","path":"\u003cstring>"},"token":"\u003cstring>","trace_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ba1f8804-0f49-46e3-b98c-55b4c7e7097f":{"bearerAuth":{"type":"http","description":"Company API key, sent as `Authorization: Bearer \u003ckey>`. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ce0e6bef-eb4b-4888-8613-d24793f6b92b":{"url":"https://shortext.ny-corp.io/api/v2.0"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Company API key, sent as `Authorization: Bearer \u003ckey>`. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Company API key, sent as `Authorization: Bearer \u003ckey>`. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/v2.0/openapi.json"},"subdomain":"n-ycorp","siteName":"Shortext","title":"List campaigns - Shortext","navMaps":{"firstHrefInVersion":{"v2.0":{"href":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","matchLevel":0},"v1.0":{"href":"/fr/api-reference/v1.0/endpoints/agents/search-agents","matchLevel":2}},"firstHrefInLanguage":{"en":{"href":"/api-reference/v2.0/endpoints/campaigns/list-campaigns","matchLevel":1},"fr":{"href":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns","matchLevel":0}}},"lastModified":"2026-10-26T07:01:49.830Z","originalFileLocation":"fr/api-reference/v2.0/endpoints/campaigns/list-campaigns.mdx","locale":"fr"},"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=\"Most recent first, 50 per page. Filter with status and name.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Shortext\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_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/n-ycorp/2itQyKG70o8hfUXJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List campaigns - Shortext\">\u003cmeta data-mint-head property=\"og:description\" content=\"Most recent first, 50 per page. Filter with status and name.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shortext\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://n-ycorp.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=List+campaigns\u0026amp;description=Most+recent+first%2C+50+per+page.+Filter+with+%60status%60+and+%60name%60.\u0026amp;theme=1ec5c1666cef603e7fd647bc\u0026amp;signature=d78f88827d51ea6aa855ee674a404f41f70ce68aed3e23c198d21cd144b7ad8f\">\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=\"List campaigns - Shortext\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Most recent first, 50 per page. Filter with status and name.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://n-ycorp.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=List+campaigns\u0026amp;description=Most+recent+first%2C+50+per+page.+Filter+with+%60status%60+and+%60name%60.\u0026amp;theme=1ec5c1666cef603e7fd647bc\u0026amp;signature=d78f88827d51ea6aa855ee674a404f41f70ce68aed3e23c198d21cd144b7ad8f\">\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/n-ycorp/2itQyKG70o8hfUXJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Shortext\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.shortext.ny-corp.io/api-reference/v2.0/endpoints/campaigns/list-campaigns\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.shortext.ny-corp.io/api-reference/v2.0/endpoints/campaigns/list-campaigns\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shortext.ny-corp.io/#organization\",\"name\":\"Shortext\",\"url\":\"https://docs.shortext.ny-corp.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/n-ycorp/BNyO30yvo2XGv-Dr/logo/light.svg?fit=max\u0026auto=format\u0026n=BNyO30yvo2XGv-Dr\u0026q=85\u0026s=321a01994cf59d9ab14c6c2d24145600\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shortext.ny-corp.io#website\",\"name\":\"Shortext\",\"url\":\"https://docs.shortext.ny-corp.io\",\"publisher\":{\"@id\":\"https://docs.shortext.ny-corp.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns#webpage\",\"url\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\",\"name\":\"List campaigns\",\"description\":\"Most recent first, 50 per page. Filter with status and name.\",\"dateModified\":\"2026-10-26T07:01:49.830Z\",\"isPartOf\":{\"@id\":\"https://docs.shortext.ny-corp.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List campaigns\",\"item\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns#apireference\",\"headline\":\"List campaigns\",\"name\":\"List campaigns\",\"description\":\"Most recent first, 50 per page. Filter with status and name.\",\"url\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shortext.ny-corp.io/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns#webpage\"},\"dateModified\":\"2026-10-26T07:01:49.830Z\",\"publisher\":{\"@id\":\"https://docs.shortext.ny-corp.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shortext.ny-corp.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Shortext\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Shortext","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://shortext.ny-corp.io/community"},{"anchor":"Blog","icon":"newspaper","href":"https://shortext.ny-corp.io/blogs"}]},"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/v2.0/endpoints/campaigns/list-campaigns"}]},{"language":"fr","tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/fr/introduction/what-is-shortext"}]},{"tab":"Référence API","icon":"square-terminal","versions":[{"version":"v2.0","default":true,"tag":"Actuelle","groups":[{"group":"Démarrer","pages":[{"title":"Introduction à l'API","href":"/fr/api-reference/introduction"},{"title":"Authentification","href":"/fr/api-reference/authentication"},{"title":"Versionnement","href":"/fr/api-reference/versioning"},{"title":"Erreurs","href":"/fr/api-reference/errors"}]},{"group":"Formats","pages":[{"title":"Format des messages","href":"/fr/api-reference/message-format"},{"title":"Types de messages WhatsApp","href":"/fr/api-reference/whatsapp-messages"},{"title":"Format des contacts","href":"/fr/api-reference/contact-format"}]},{"group":"Intégrations","pages":[{"title":"Webhooks","href":"/fr/api-reference/webhooks"},{"title":"Sessions hébergées","href":"/fr/api-reference/hosted-sessions"},{"title":"Intégration d'un endpoint Shortext","href":"/fr/api-reference/shortext-endpoint"}]},{"group":"Campagnes et relances","pages":[{"title":"Envoyer une campagne","href":"/fr/api-reference/guides/send-a-campaign"},{"title":"Lire le rapport d'une campagne","href":"/fr/api-reference/guides/campaign-report"},{"title":"Relances","href":"/fr/api-reference/guides/follow-ups"}]},{"group":"Guides","pages":[{"title":"Démarrer une conversation et répondre","href":"/fr/api-reference/guides/start-a-conversation"},{"title":"Créer des modèles WhatsApp","href":"/fr/api-reference/guides/create-templates"},{"title":"Envoyer un modèle WhatsApp","href":"/fr/api-reference/guides/send-a-template"},{"title":"Prise en main et retour à l'agent","href":"/fr/api-reference/guides/handover"},{"title":"Connecter le WhatsApp d'un client","href":"/fr/api-reference/guides/connect-whatsapp"},{"title":"Gérer les tickets","href":"/fr/api-reference/guides/manage-tickets"},{"title":"Connaissances de l'agent","href":"/fr/api-reference/guides/agent-knowledge"},{"title":"Liens dynamiques","href":"/fr/api-reference/guides/dynamic-links"},{"title":"Solde et mouvements du portefeuille","href":"/fr/api-reference/guides/balance"},{"title":"Migrer de la v1.0 à la v2.0","href":"/fr/api-reference/guides/migrate-to-v2"}]},{"group":"Endpoints","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents","href":"/fr/api-reference/v2.0/endpoints/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /agents","href":"/fr/api-reference/v2.0/endpoints/agents/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{id}","href":"/fr/api-reference/v2.0/endpoints/agents/get-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /agents/{id}","href":"/fr/api-reference/v2.0/endpoints/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{id}","href":"/fr/api-reference/v2.0/endpoints/agents/update-an-agent"},{"title":"Restore a deleted agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{id}/restore","href":"/fr/api-reference/v2.0/endpoints/agents/restore-a-deleted-agent"}]},{"group":"Knowledge","pages":[{"title":"List knowledge documents","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/knowledge","href":"/fr/api-reference/v2.0/endpoints/knowledge/list-knowledge-documents"},{"title":"Add a knowledge document","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /agents/{agent}/knowledge","href":"/fr/api-reference/v2.0/endpoints/knowledge/add-a-knowledge-document"},{"title":"Get a knowledge document","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/get-a-knowledge-document"},{"title":"Delete a knowledge document","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /agents/{agent}/knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/delete-a-knowledge-document"},{"title":"Update a knowledge document","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{agent}/knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/update-a-knowledge-document"},{"title":"Knowledge base usage","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/knowledge/usage","href":"/fr/api-reference/v2.0/endpoints/knowledge/knowledge-base-usage"},{"title":"List contact knowledge","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/contact-knowledge","href":"/fr/api-reference/v2.0/endpoints/knowledge/list-contact-knowledge"},{"title":"Add contact knowledge","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /agents/{agent}/contact-knowledge","href":"/fr/api-reference/v2.0/endpoints/knowledge/add-contact-knowledge"},{"title":"Get a contact knowledge entry","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/contact-knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/get-a-contact-knowledge-entry"},{"title":"Delete contact knowledge","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /agents/{agent}/contact-knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/delete-contact-knowledge"},{"title":"Update contact knowledge","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{agent}/contact-knowledge/{id}","href":"/fr/api-reference/v2.0/endpoints/knowledge/update-contact-knowledge"}]},{"group":"Dynamic links","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links/platforms","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/list-apps"},{"title":"Add an app","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /deep-links/platforms","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/add-an-app"},{"title":"Get an app","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links/platforms/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/get-an-app"},{"title":"Delete an app","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /deep-links/platforms/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/delete-an-app"},{"title":"Update an app","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /deep-links/platforms/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/update-an-app"},{"title":"Domain verification file","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links/platforms/{id}/verification-file","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/domain-verification-file"},{"title":"List dynamic links","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/list-dynamic-links"},{"title":"Create a dynamic link","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /deep-links","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/create-a-dynamic-link"},{"title":"Get a dynamic link","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/get-a-dynamic-link"},{"title":"Delete a dynamic link","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /deep-links/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/delete-a-dynamic-link"},{"title":"Update a dynamic link","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /deep-links/{id}","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/update-a-dynamic-link"},{"title":"Clicks of a dynamic link","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /deep-links/{id}/clicks","href":"/fr/api-reference/v2.0/endpoints/dynamic-links/clicks-of-a-dynamic-link"}]},{"group":"Billing","pages":[{"title":"Company balance","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /balance","href":"/fr/api-reference/v2.0/endpoints/billing/company-balance"},{"title":"Wallet movements","description":"Settled movements, most recent first, 50 per page. A debit appears once it is settled.","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /balance/transactions","href":"/fr/api-reference/v2.0/endpoints/billing/wallet-movements"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns","href":"/fr/api-reference/v2.0/endpoints/campaigns/list-campaigns"},{"title":"Create a campaign","description":"Created as a draft: check it (`GET /campaigns/{id}/checks`) and launch it (`POST /campaigns/{id}/launch`).","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaigns","href":"/fr/api-reference/v2.0/endpoints/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/get-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /campaigns/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/delete-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /campaigns/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/update-a-campaign"},{"title":"Launch checks of a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns/{id}/checks","href":"/fr/api-reference/v2.0/endpoints/campaigns/launch-checks-of-a-campaign"},{"title":"Estimated cost of a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns/{id}/estimate","href":"/fr/api-reference/v2.0/endpoints/campaigns/estimated-cost-of-a-campaign"},{"title":"Launch a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaigns/{id}/launch","href":"/fr/api-reference/v2.0/endpoints/campaigns/launch-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaigns/{id}/pause","href":"/fr/api-reference/v2.0/endpoints/campaigns/pause-a-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaigns/{id}/resume","href":"/fr/api-reference/v2.0/endpoints/campaigns/resume-a-paused-campaign"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaigns/{id}/duplicate","href":"/fr/api-reference/v2.0/endpoints/campaigns/duplicate-a-campaign"},{"title":"Report of a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns/{id}/report","href":"/fr/api-reference/v2.0/endpoints/campaigns/report-of-a-campaign"},{"title":"Recipients of a campaign","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaigns/{id}/recipients","href":"/fr/api-reference/v2.0/endpoints/campaigns/recipients-of-a-campaign"},{"title":"Upload a contact file","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaign-imports","href":"/fr/api-reference/v2.0/endpoints/campaigns/upload-a-contact-file"},{"title":"Get a contact file","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaign-imports/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/get-a-contact-file"},{"title":"Map the columns of a contact file","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /campaign-imports/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/map-the-columns-of-a-contact-file"},{"title":"Check a contact file","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /campaign-imports/{id}/check","href":"/fr/api-reference/v2.0/endpoints/campaigns/check-a-contact-file"},{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaign-segments","href":"/fr/api-reference/v2.0/endpoints/campaigns/list-segments"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /campaign-segments/{id}","href":"/fr/api-reference/v2.0/endpoints/campaigns/get-a-segment"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /channels","href":"/fr/api-reference/v2.0/endpoints/channels/list-channels"},{"title":"Get a channel","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /channels/{type}/{id}","href":"/fr/api-reference/v2.0/endpoints/channels/get-a-channel"},{"title":"Attach or move a channel","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json put /channels/{type}/{id}/agent","href":"/fr/api-reference/v2.0/endpoints/channels/attach-or-move-a-channel"},{"title":"Detach a channel from its agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /channels/{type}/{id}/agent","href":"/fr/api-reference/v2.0/endpoints/channels/detach-a-channel-from-its-agent"},{"title":"Create a Shortext endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /channels/shortext","href":"/fr/api-reference/v2.0/endpoints/channels/create-a-shortext-endpoint"},{"title":"Delete a Shortext endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /channels/shortext/{id}","href":"/fr/api-reference/v2.0/endpoints/channels/delete-a-shortext-endpoint"},{"title":"Update a Shortext endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /channels/shortext/{id}","href":"/fr/api-reference/v2.0/endpoints/channels/update-a-shortext-endpoint"},{"title":"Rotate the webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /channels/shortext/{id}/rotate-secret","href":"/fr/api-reference/v2.0/endpoints/channels/rotate-the-webhook-signing-secret"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /conversations","href":"/fr/api-reference/v2.0/endpoints/conversations/list-conversations"},{"title":"Start a conversation","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /conversations","href":"/fr/api-reference/v2.0/endpoints/conversations/start-a-conversation"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /conversations/{id}","href":"/fr/api-reference/v2.0/endpoints/conversations/get-a-conversation"},{"title":"List the messages of a conversation","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /conversations/{id}/messages","href":"/fr/api-reference/v2.0/endpoints/conversations/list-the-messages-of-a-conversation"},{"title":"Reply to a conversation","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /conversations/{id}/messages","href":"/fr/api-reference/v2.0/endpoints/conversations/reply-to-a-conversation"},{"title":"Take a conversation over","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json put /conversations/{id}/handover","href":"/fr/api-reference/v2.0/endpoints/conversations/take-a-conversation-over"},{"title":"Hand a conversation back to the agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /conversations/{id}/handover","href":"/fr/api-reference/v2.0/endpoints/conversations/hand-a-conversation-back-to-the-agent"},{"title":"Assign a conversation","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json put /conversations/{id}/assignee","href":"/fr/api-reference/v2.0/endpoints/conversations/assign-a-conversation"},{"title":"List assignees","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /conversations/assignees","href":"/fr/api-reference/v2.0/endpoints/conversations/list-assignees"}]},{"group":"Follow-ups","pages":[{"title":"List follow-ups","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /follow-ups","href":"/fr/api-reference/v2.0/endpoints/follow-ups/list-follow-ups"},{"title":"Schedule a follow-up","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /follow-ups","href":"/fr/api-reference/v2.0/endpoints/follow-ups/schedule-a-follow-up"},{"title":"Get a follow-up","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /follow-ups/{id}","href":"/fr/api-reference/v2.0/endpoints/follow-ups/get-a-follow-up"},{"title":"Reschedule a follow-up","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /follow-ups/{id}/reschedule","href":"/fr/api-reference/v2.0/endpoints/follow-ups/reschedule-a-follow-up"},{"title":"Resolve a follow-up","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /follow-ups/{id}/resolve","href":"/fr/api-reference/v2.0/endpoints/follow-ups/resolve-a-follow-up"},{"title":"Cancel a follow-up","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /follow-ups/{id}/cancel","href":"/fr/api-reference/v2.0/endpoints/follow-ups/cancel-a-follow-up"},{"title":"List follow-up types","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /follow-up-types","href":"/fr/api-reference/v2.0/endpoints/follow-ups/list-follow-up-types"},{"title":"Create a follow-up type","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /follow-up-types","href":"/fr/api-reference/v2.0/endpoints/follow-ups/create-a-follow-up-type"},{"title":"Get a follow-up type","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /follow-up-types/{id}","href":"/fr/api-reference/v2.0/endpoints/follow-ups/get-a-follow-up-type"},{"title":"Delete a follow-up type","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /follow-up-types/{id}","href":"/fr/api-reference/v2.0/endpoints/follow-ups/delete-a-follow-up-type"},{"title":"Update a follow-up type","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /follow-up-types/{id}","href":"/fr/api-reference/v2.0/endpoints/follow-ups/update-a-follow-up-type"}]},{"group":"Account","pages":[{"title":"Current API key","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /me","href":"/fr/api-reference/v2.0/endpoints/account/current-api-key"}]},{"group":"Tickets","pages":[{"title":"List SLA policies","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/sla-policies","href":"/fr/api-reference/v2.0/endpoints/tickets/list-sla-policies"},{"title":"Create an SLA policy","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /agents/{agent}/sla-policies","href":"/fr/api-reference/v2.0/endpoints/tickets/create-an-sla-policy"},{"title":"Get an SLA policy","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/sla-policies/{priority}","href":"/fr/api-reference/v2.0/endpoints/tickets/get-an-sla-policy"},{"title":"Delete an SLA policy","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /agents/{agent}/sla-policies/{priority}","href":"/fr/api-reference/v2.0/endpoints/tickets/delete-an-sla-policy"},{"title":"Update an SLA policy","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{agent}/sla-policies/{priority}","href":"/fr/api-reference/v2.0/endpoints/tickets/update-an-sla-policy"},{"title":"List tickets","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /tickets","href":"/fr/api-reference/v2.0/endpoints/tickets/list-tickets"},{"title":"Open a ticket","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /tickets","href":"/fr/api-reference/v2.0/endpoints/tickets/open-a-ticket"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /tickets/{id}","href":"/fr/api-reference/v2.0/endpoints/tickets/get-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /tickets/{id}","href":"/fr/api-reference/v2.0/endpoints/tickets/update-a-ticket"},{"title":"Ticket activity","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /tickets/{id}/activities","href":"/fr/api-reference/v2.0/endpoints/tickets/ticket-activity"},{"title":"Add a note","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /tickets/{id}/comments","href":"/fr/api-reference/v2.0/endpoints/tickets/add-a-note"},{"title":"Answer the contact","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /tickets/{id}/responses","href":"/fr/api-reference/v2.0/endpoints/tickets/answer-the-contact"},{"title":"List ticket statuses","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/ticket-statuses","href":"/fr/api-reference/v2.0/endpoints/tickets/list-ticket-statuses"},{"title":"Create a ticket status","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /agents/{agent}/ticket-statuses","href":"/fr/api-reference/v2.0/endpoints/tickets/create-a-ticket-status"},{"title":"Get a ticket status","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /agents/{agent}/ticket-statuses/{code}","href":"/fr/api-reference/v2.0/endpoints/tickets/get-a-ticket-status"},{"title":"Delete a ticket status","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /agents/{agent}/ticket-statuses/{code}","href":"/fr/api-reference/v2.0/endpoints/tickets/delete-a-ticket-status"},{"title":"Update a ticket status","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /agents/{agent}/ticket-statuses/{code}","href":"/fr/api-reference/v2.0/endpoints/tickets/update-a-ticket-status"}]},{"group":"Templates","pages":[{"title":"List WhatsApp templates","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /templates","href":"/fr/api-reference/v2.0/endpoints/templates/list-whatsapp-templates"},{"title":"Create a WhatsApp template","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /templates","href":"/fr/api-reference/v2.0/endpoints/templates/create-a-whatsapp-template"},{"title":"Get a WhatsApp template","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /templates/{id}","href":"/fr/api-reference/v2.0/endpoints/templates/get-a-whatsapp-template"},{"title":"Edit a WhatsApp template","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json patch /templates/{id}","href":"/fr/api-reference/v2.0/endpoints/templates/edit-a-whatsapp-template"}]},{"group":"Hosted sessions","pages":[{"title":"Purposes of the hosted sessions","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /hosted-sessions/purposes","href":"/fr/api-reference/v2.0/endpoints/hosted-sessions/purposes-of-the-hosted-sessions"},{"title":"List hosted sessions","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /hosted-sessions","href":"/fr/api-reference/v2.0/endpoints/hosted-sessions/list-hosted-sessions"},{"title":"Create a hosted session","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /hosted-sessions","href":"/fr/api-reference/v2.0/endpoints/hosted-sessions/create-a-hosted-session"},{"title":"Get a hosted session","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /hosted-sessions/{id}","href":"/fr/api-reference/v2.0/endpoints/hosted-sessions/get-a-hosted-session"},{"title":"Cancel a hosted session","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /hosted-sessions/{id}","href":"/fr/api-reference/v2.0/endpoints/hosted-sessions/cancel-a-hosted-session"}]},{"group":"Webhooks","pages":[{"title":"Webhook event catalog","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /webhooks/events","href":"/fr/api-reference/v2.0/endpoints/webhooks/webhook-event-catalog"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /webhooks","href":"/fr/api-reference/v2.0/endpoints/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /webhooks","href":"/fr/api-reference/v2.0/endpoints/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /webhooks/{id}","href":"/fr/api-reference/v2.0/endpoints/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json put /webhooks/{id}","href":"/fr/api-reference/v2.0/endpoints/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json delete /webhooks/{id}","href":"/fr/api-reference/v2.0/endpoints/webhooks/delete-a-webhook-endpoint"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /webhooks/{id}/rotate-secret","href":"/fr/api-reference/v2.0/endpoints/webhooks/rotate-the-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /webhooks/{id}/test","href":"/fr/api-reference/v2.0/endpoints/webhooks/send-a-test-event"},{"title":"Delivery history","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json get /webhooks/{id}/deliveries","href":"/fr/api-reference/v2.0/endpoints/webhooks/delivery-history"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/v2.0/openapi.json post /webhooks/{id}/deliveries/{delivery}/retry","href":"/fr/api-reference/v2.0/endpoints/webhooks/redeliver-an-event"}]}]}]},{"version":"v1.0","tag":"Historique","pages":[{"title":"v1.0","href":"/fr/api-reference/v1.0/endpoints/agents/search-agents"}]}]}]}]},"title":"List campaigns - Shortext","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-7TwLLapg.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}