[{"data":1,"prerenderedAt":1673},["ShallowReactive",2],{"navigation":3,"/rest-api/campaigns":151,"/rest-api/campaigns-surround":1668},[4,26,123,144],{"title":5,"path":6,"stem":7,"children":8,"icon":10},"Introduction","/getting-started","1.getting-started/1.index",[9,11,16,21],{"title":5,"path":6,"stem":7,"icon":10},"i-lucide-house",{"title":12,"path":13,"stem":14,"icon":15},"Authentication","/getting-started/authentication","1.getting-started/2.authentication","i-lucide-key-round",{"title":17,"path":18,"stem":19,"icon":20},"Rate Limits","/getting-started/rate-limits","1.getting-started/3.rate-limits","i-lucide-gauge",{"title":22,"path":23,"stem":24,"icon":25},"Error Handling","/getting-started/errors","1.getting-started/4.errors","i-lucide-triangle-alert",{"title":27,"path":28,"stem":29,"children":30,"icon":32},"API Reference","/rest-api","2.rest-api/1.index",[31,33,38,43,48,53,58,63,68,73,78,83,88,93,98,103,108,113,118],{"title":27,"path":28,"stem":29,"icon":32},"i-lucide-code-2",{"title":34,"path":35,"stem":36,"icon":37},"Lists & Segments","/rest-api/lists","2.rest-api/10.lists","i-lucide-list",{"title":39,"path":40,"stem":41,"icon":42},"AI Agents","/rest-api/ai-agents","2.rest-api/11.ai-agents","i-lucide-bot",{"title":44,"path":45,"stem":46,"icon":47},"Campaigns","/rest-api/campaigns","2.rest-api/12.campaigns","i-lucide-send",{"title":49,"path":50,"stem":51,"icon":52},"Support Tickets","/rest-api/tickets","2.rest-api/13.tickets","i-lucide-ticket",{"title":54,"path":55,"stem":56,"icon":57},"Web Chat","/rest-api/web-chat","2.rest-api/14.web-chat","i-lucide-message-square",{"title":59,"path":60,"stem":61,"icon":62},"Knowledge Base","/rest-api/knowledge-base","2.rest-api/15.knowledge-base","i-lucide-book-open",{"title":64,"path":65,"stem":66,"icon":67},"Voice","/rest-api/voice","2.rest-api/16.voice","i-lucide-mic",{"title":69,"path":70,"stem":71,"icon":72},"Media","/rest-api/media","2.rest-api/17.media","i-lucide-image",{"title":74,"path":75,"stem":76,"icon":77},"Channels","/rest-api/channels","2.rest-api/18.channels","i-lucide-plug",{"title":79,"path":80,"stem":81,"icon":82},"Partners","/rest-api/partners","2.rest-api/19.partners","i-lucide-handshake",{"title":84,"path":85,"stem":86,"icon":87},"Contacts","/rest-api/contacts","2.rest-api/2.contacts","i-lucide-users",{"title":89,"path":90,"stem":91,"icon":92},"Messages","/rest-api/messages","2.rest-api/3.messages","i-lucide-message-circle",{"title":94,"path":95,"stem":96,"icon":97},"Bookings","/rest-api/bookings","2.rest-api/4.bookings","i-lucide-calendar",{"title":99,"path":100,"stem":101,"icon":102},"Orders","/rest-api/orders","2.rest-api/5.orders","i-lucide-shopping-bag",{"title":104,"path":105,"stem":106,"icon":107},"Webhooks API","/rest-api/webhooks-api","2.rest-api/6.webhooks-api","i-lucide-webhook",{"title":109,"path":110,"stem":111,"icon":112},"Account","/rest-api/account","2.rest-api/7.account","i-lucide-building-2",{"title":114,"path":115,"stem":116,"icon":117},"Team Members","/rest-api/team","2.rest-api/8.team","i-lucide-users-2",{"title":119,"path":120,"stem":121,"icon":122},"Tags","/rest-api/tags","2.rest-api/9.tags","i-lucide-tag",{"title":124,"path":125,"stem":126,"children":127,"icon":129},"Webhooks Overview","/webhooks","3.webhooks/1.index",[128,130,134,139],{"title":124,"path":125,"stem":126,"icon":129},"i-lucide-zap",{"title":131,"path":132,"stem":133,"icon":37},"Events & Payloads","/webhooks/events","3.webhooks/2.events",{"title":135,"path":136,"stem":137,"icon":138},"Signature Verification","/webhooks/security","3.webhooks/3.security","i-lucide-shield-check",{"title":140,"path":141,"stem":142,"icon":143},"Delivery & Retries","/webhooks/delivery","3.webhooks/4.delivery","i-lucide-refresh-cw",{"title":145,"path":146,"stem":147,"children":148,"icon":150},"Changelog","/changelog","4.changelog/1.index",[149],{"title":145,"path":146,"stem":147,"icon":150},"i-lucide-history",{"id":152,"title":44,"body":153,"description":1661,"extension":1662,"links":1663,"meta":1664,"navigation":1665,"path":45,"seo":1666,"stem":46,"__hash__":1667},"docs/2.rest-api/12.campaigns.md",{"type":154,"value":155,"toc":1643},"minimark",[156,161,165,183,186,190,200,211,213,217,643,748,750,754,765,812,814,818,827,832,997,1008,1118,1132,1136,1145,1215,1222,1224,1228,1237,1239,1243,1252,1265,1267,1271,1280,1289,1291,1295,1304,1307,1309,1313,1322,1330,1332,1336,1345,1348,1350,1354,1363,1374,1376,1380,1389,1392,1436,1639],[157,158,160],"h2",{"id":159},"overview","Overview",[162,163,164],"p",{},"Outreach Campaigns let you send a sequence of messages to a list of contacts over multiple days, with built-in daily rate limiting that prevents your sending number from being flagged or blocked. Each campaign draws contacts from explicit IDs, contact lists, segments, or a combination.",[166,167,170],"callout",{"color":168,"icon":169},"primary","i-lucide-info",[162,171,172,173,177,178,182],{},"Campaigns consume your ",[174,175,176],"strong",{},"outreach campaign quota",". Check your remaining quota with ",[179,180,181],"code",{},"GET /account/subscription",".",[184,185],"hr",{},[157,187,189],{"id":188},"campaign-lifecycle","Campaign lifecycle",[191,192,197],"pre",{"className":193,"code":195,"language":196},[194],"language-text","draft → running → paused → running → completed\n                          ↘ cancelled\n","text",[179,198,195],{"__ignoreMap":199},"",[162,201,202,203,206,207,210],{},"A campaign must be explicitly ",[174,204,205],{},"started"," after creation. It can be paused and resumed at any time. Once all contacts have been messaged, the status moves to ",[179,208,209],{},"completed"," automatically.",[184,212],{},[157,214,216],{"id":215},"the-campaign-object","The Campaign object",[191,218,222],{"className":219,"code":220,"language":221,"meta":199,"style":199},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": 12,\n  \"name\": \"Spring Promo 2026\",\n  \"status\": \"running\",\n  \"total_contacts\": 250,\n  \"success_count\": 87,\n  \"failed_count\": 3,\n  \"campaign_day\": 4,\n  \"messages_sent_today\": 65,\n  \"is_new_number\": false,\n  \"started_at\": \"2026-03-05T08:00:00.000000Z\",\n  \"completed_at\": null,\n  \"progress_percentage\": 36,\n  \"daily_limit\": 65,\n  \"remaining_today\": 0,\n  \"client_setting\": { \"id\": 5, \"name\": \"Business WhatsApp\", \"type\": \"whatsapp\" },\n  \"campaign_contacts_count\": 250,\n  \"sent_contacts_count\": 87,\n  \"failed_contacts_count\": 3,\n  \"pending_contacts_count\": 160,\n  \"created_at\": \"2026-03-04T10:00:00.000000Z\"\n}\n","json",[179,223,224,233,256,279,300,317,334,351,368,385,400,421,436,453,469,486,552,568,584,600,617,637],{"__ignoreMap":199},[225,226,229],"span",{"class":227,"line":228},"line",1,[225,230,232],{"class":231},"sMK4o","{\n",[225,234,236,239,243,246,249,253],{"class":227,"line":235},2,[225,237,238],{"class":231},"  \"",[225,240,242],{"class":241},"spNyl","id",[225,244,245],{"class":231},"\"",[225,247,248],{"class":231},":",[225,250,252],{"class":251},"sbssI"," 12",[225,254,255],{"class":231},",\n",[225,257,259,261,264,266,268,271,275,277],{"class":227,"line":258},3,[225,260,238],{"class":231},[225,262,263],{"class":241},"name",[225,265,245],{"class":231},[225,267,248],{"class":231},[225,269,270],{"class":231}," \"",[225,272,274],{"class":273},"sfazB","Spring Promo 2026",[225,276,245],{"class":231},[225,278,255],{"class":231},[225,280,282,284,287,289,291,293,296,298],{"class":227,"line":281},4,[225,283,238],{"class":231},[225,285,286],{"class":241},"status",[225,288,245],{"class":231},[225,290,248],{"class":231},[225,292,270],{"class":231},[225,294,295],{"class":273},"running",[225,297,245],{"class":231},[225,299,255],{"class":231},[225,301,303,305,308,310,312,315],{"class":227,"line":302},5,[225,304,238],{"class":231},[225,306,307],{"class":241},"total_contacts",[225,309,245],{"class":231},[225,311,248],{"class":231},[225,313,314],{"class":251}," 250",[225,316,255],{"class":231},[225,318,320,322,325,327,329,332],{"class":227,"line":319},6,[225,321,238],{"class":231},[225,323,324],{"class":241},"success_count",[225,326,245],{"class":231},[225,328,248],{"class":231},[225,330,331],{"class":251}," 87",[225,333,255],{"class":231},[225,335,337,339,342,344,346,349],{"class":227,"line":336},7,[225,338,238],{"class":231},[225,340,341],{"class":241},"failed_count",[225,343,245],{"class":231},[225,345,248],{"class":231},[225,347,348],{"class":251}," 3",[225,350,255],{"class":231},[225,352,354,356,359,361,363,366],{"class":227,"line":353},8,[225,355,238],{"class":231},[225,357,358],{"class":241},"campaign_day",[225,360,245],{"class":231},[225,362,248],{"class":231},[225,364,365],{"class":251}," 4",[225,367,255],{"class":231},[225,369,371,373,376,378,380,383],{"class":227,"line":370},9,[225,372,238],{"class":231},[225,374,375],{"class":241},"messages_sent_today",[225,377,245],{"class":231},[225,379,248],{"class":231},[225,381,382],{"class":251}," 65",[225,384,255],{"class":231},[225,386,388,390,393,395,397],{"class":227,"line":387},10,[225,389,238],{"class":231},[225,391,392],{"class":241},"is_new_number",[225,394,245],{"class":231},[225,396,248],{"class":231},[225,398,399],{"class":231}," false,\n",[225,401,403,405,408,410,412,414,417,419],{"class":227,"line":402},11,[225,404,238],{"class":231},[225,406,407],{"class":241},"started_at",[225,409,245],{"class":231},[225,411,248],{"class":231},[225,413,270],{"class":231},[225,415,416],{"class":273},"2026-03-05T08:00:00.000000Z",[225,418,245],{"class":231},[225,420,255],{"class":231},[225,422,424,426,429,431,433],{"class":227,"line":423},12,[225,425,238],{"class":231},[225,427,428],{"class":241},"completed_at",[225,430,245],{"class":231},[225,432,248],{"class":231},[225,434,435],{"class":231}," null,\n",[225,437,439,441,444,446,448,451],{"class":227,"line":438},13,[225,440,238],{"class":231},[225,442,443],{"class":241},"progress_percentage",[225,445,245],{"class":231},[225,447,248],{"class":231},[225,449,450],{"class":251}," 36",[225,452,255],{"class":231},[225,454,456,458,461,463,465,467],{"class":227,"line":455},14,[225,457,238],{"class":231},[225,459,460],{"class":241},"daily_limit",[225,462,245],{"class":231},[225,464,248],{"class":231},[225,466,382],{"class":251},[225,468,255],{"class":231},[225,470,472,474,477,479,481,484],{"class":227,"line":471},15,[225,473,238],{"class":231},[225,475,476],{"class":241},"remaining_today",[225,478,245],{"class":231},[225,480,248],{"class":231},[225,482,483],{"class":251}," 0",[225,485,255],{"class":231},[225,487,489,491,494,496,498,501,503,506,508,510,513,516,518,520,522,524,526,529,531,533,535,538,540,542,544,547,549],{"class":227,"line":488},16,[225,490,238],{"class":231},[225,492,493],{"class":241},"client_setting",[225,495,245],{"class":231},[225,497,248],{"class":231},[225,499,500],{"class":231}," {",[225,502,270],{"class":231},[225,504,242],{"class":505},"sBMFI",[225,507,245],{"class":231},[225,509,248],{"class":231},[225,511,512],{"class":251}," 5",[225,514,515],{"class":231},",",[225,517,270],{"class":231},[225,519,263],{"class":505},[225,521,245],{"class":231},[225,523,248],{"class":231},[225,525,270],{"class":231},[225,527,528],{"class":273},"Business WhatsApp",[225,530,245],{"class":231},[225,532,515],{"class":231},[225,534,270],{"class":231},[225,536,537],{"class":505},"type",[225,539,245],{"class":231},[225,541,248],{"class":231},[225,543,270],{"class":231},[225,545,546],{"class":273},"whatsapp",[225,548,245],{"class":231},[225,550,551],{"class":231}," },\n",[225,553,555,557,560,562,564,566],{"class":227,"line":554},17,[225,556,238],{"class":231},[225,558,559],{"class":241},"campaign_contacts_count",[225,561,245],{"class":231},[225,563,248],{"class":231},[225,565,314],{"class":251},[225,567,255],{"class":231},[225,569,571,573,576,578,580,582],{"class":227,"line":570},18,[225,572,238],{"class":231},[225,574,575],{"class":241},"sent_contacts_count",[225,577,245],{"class":231},[225,579,248],{"class":231},[225,581,331],{"class":251},[225,583,255],{"class":231},[225,585,587,589,592,594,596,598],{"class":227,"line":586},19,[225,588,238],{"class":231},[225,590,591],{"class":241},"failed_contacts_count",[225,593,245],{"class":231},[225,595,248],{"class":231},[225,597,348],{"class":251},[225,599,255],{"class":231},[225,601,603,605,608,610,612,615],{"class":227,"line":602},20,[225,604,238],{"class":231},[225,606,607],{"class":241},"pending_contacts_count",[225,609,245],{"class":231},[225,611,248],{"class":231},[225,613,614],{"class":251}," 160",[225,616,255],{"class":231},[225,618,620,622,625,627,629,631,634],{"class":227,"line":619},21,[225,621,238],{"class":231},[225,623,624],{"class":241},"created_at",[225,626,245],{"class":231},[225,628,248],{"class":231},[225,630,270],{"class":231},[225,632,633],{"class":273},"2026-03-04T10:00:00.000000Z",[225,635,636],{"class":231},"\"\n",[225,638,640],{"class":227,"line":639},22,[225,641,642],{"class":231},"}\n",[644,645,646,662],"table",{},[647,648,649],"thead",{},[650,651,652,656,659],"tr",{},[653,654,655],"th",{},"Field",[653,657,658],{},"Type",[653,660,661],{},"Description",[663,664,665,691,703,714,725,736],"tbody",{},[650,666,667,672,675],{},[668,669,670],"td",{},[179,671,286],{},[668,673,674],{},"string",[668,676,677,680,681,680,683,680,686,680,688],{},[179,678,679],{},"draft",", ",[179,682,295],{},[179,684,685],{},"paused",[179,687,209],{},[179,689,690],{},"cancelled",[650,692,693,697,700],{},[668,694,695],{},[179,696,358],{},[668,698,699],{},"integer",[668,701,702],{},"How many days the campaign has been running",[650,704,705,709,711],{},[668,706,707],{},[179,708,443],{},[668,710,699],{},[668,712,713],{},"0–100, based on contacted vs total",[650,715,716,720,722],{},[668,717,718],{},[179,719,460],{},[668,721,699],{},[668,723,724],{},"Max messages the system will send today",[650,726,727,731,733],{},[668,728,729],{},[179,730,476],{},[668,732,699],{},[668,734,735],{},"Remaining sends for today",[650,737,738,742,745],{},[668,739,740],{},[179,741,392],{},[668,743,744],{},"boolean",[668,746,747],{},"Conservative warm-up mode for new phone numbers",[184,749],{},[157,751,753],{"id":752},"list-campaigns","List campaigns",[191,755,759],{"className":756,"code":757,"language":758,"meta":199,"style":199},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET /api/v1/campaigns\n","http",[179,760,761],{"__ignoreMap":199},[225,762,763],{"class":227,"line":228},[225,764,757],{},[644,766,767,778],{},[647,768,769],{},[650,770,771,774,776],{},[653,772,773],{},"Parameter",[653,775,658],{},[653,777,661],{},[663,779,780,800],{},[650,781,782,786,788],{},[668,783,784],{},[179,785,286],{},[668,787,674],{},[668,789,790,680,792,680,794,680,796,680,798],{},[179,791,679],{},[179,793,295],{},[179,795,685],{},[179,797,209],{},[179,799,690],{},[650,801,802,807,809],{},[668,803,804],{},[179,805,806],{},"per_page",[668,808,699],{},[668,810,811],{},"Max 100 (default 25)",[184,813],{},[157,815,817],{"id":816},"create-a-campaign","Create a campaign",[191,819,821],{"className":756,"code":820,"language":758,"meta":199,"style":199},"POST /api/v1/campaigns\n",[179,822,823],{"__ignoreMap":199},[225,824,825],{"class":227,"line":228},[225,826,820],{},[828,829,831],"h3",{"id":830},"request-body","Request body",[644,833,834,848],{},[647,835,836],{},[650,837,838,840,842,845],{},[653,839,655],{},[653,841,658],{},[653,843,844],{},"Required",[653,846,847],{},"Notes",[663,849,850,863,880,895,922,936,954,969,983],{},[650,851,852,856,858,861],{},[668,853,854],{},[179,855,263],{},[668,857,674],{},[668,859,860],{},"✓",[668,862],{},[650,864,865,870,872,874],{},[668,866,867],{},[179,868,869],{},"channel_id",[668,871,699],{},[668,873,860],{},[668,875,876,877],{},"ClientSetting ID — get from ",[179,878,879],{},"GET /account/channels",[650,881,882,887,890,892],{},[668,883,884],{},[179,885,886],{},"messages",[668,888,889],{},"array",[668,891,860],{},[668,893,894],{},"Sequence of message objects",[650,896,897,902,904,906],{},[668,898,899],{},[179,900,901],{},"messages[].type",[668,903,674],{},[668,905,860],{},[668,907,908,680,910,680,913,680,916,680,919],{},[179,909,196],{},[179,911,912],{},"image",[179,914,915],{},"document",[179,917,918],{},"video",[179,920,921],{},"audio",[650,923,924,929,931,933],{},[668,925,926],{},[179,927,928],{},"messages[].content",[668,930,674],{},[668,932,860],{},[668,934,935],{},"Message text or media URL",[650,937,938,942,944,947],{},[668,939,940],{},[179,941,392],{},[668,943,744],{},[668,945,946],{},"No",[668,948,949,950,953],{},"Use conservative warm-up daily limits (default: ",[179,951,952],{},"false",")",[650,955,956,961,963,966],{},[668,957,958],{},[179,959,960],{},"contact_ids",[668,962,889],{},[668,964,965],{},"No*",[668,967,968],{},"Explicit contact IDs to target",[650,970,971,976,978,980],{},[668,972,973],{},[179,974,975],{},"list_ids",[668,977,889],{},[668,979,965],{},[668,981,982],{},"Pull contacts from these contact lists",[650,984,985,990,992,994],{},[668,986,987],{},[179,988,989],{},"segment_ids",[668,991,889],{},[668,993,965],{},[668,995,996],{},"Pull contacts from these segments",[162,998,999,1000,680,1002,1004,1005,1007],{},"*At least one of ",[179,1001,960],{},[179,1003,975],{},", or ",[179,1006,989],{}," is required.",[191,1009,1013],{"className":1010,"code":1011,"language":1012,"meta":199,"style":199},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl -X POST https://dashboard.skylightchat.com/api/v1/campaigns \\\n  -H \"X-Api-Key: ••••••••••••\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Spring Promo 2026\",\n    \"channel_id\": 5,\n    \"messages\": [\n      { \"type\": \"text\", \"content\": \"Hi! We have a special offer just for you 🎉\" },\n      { \"type\": \"text\", \"content\": \"Reply YES to learn more, or STOP to unsubscribe.\" }\n    ],\n    \"list_ids\": [3, 7],\n    \"is_new_number\": false\n  }'\n","bash",[179,1014,1015,1033,1047,1060,1070,1075,1080,1085,1090,1095,1100,1105,1110],{"__ignoreMap":199},[225,1016,1017,1020,1023,1026,1029],{"class":227,"line":228},[225,1018,1019],{"class":505},"curl",[225,1021,1022],{"class":273}," -X",[225,1024,1025],{"class":273}," POST",[225,1027,1028],{"class":273}," https://dashboard.skylightchat.com/api/v1/campaigns",[225,1030,1032],{"class":1031},"sTEyZ"," \\\n",[225,1034,1035,1038,1040,1043,1045],{"class":227,"line":235},[225,1036,1037],{"class":273},"  -H",[225,1039,270],{"class":231},[225,1041,1042],{"class":273},"X-Api-Key: ••••••••••••",[225,1044,245],{"class":231},[225,1046,1032],{"class":1031},[225,1048,1049,1051,1053,1056,1058],{"class":227,"line":258},[225,1050,1037],{"class":273},[225,1052,270],{"class":231},[225,1054,1055],{"class":273},"Content-Type: application/json",[225,1057,245],{"class":231},[225,1059,1032],{"class":1031},[225,1061,1062,1065,1068],{"class":227,"line":281},[225,1063,1064],{"class":273},"  -d",[225,1066,1067],{"class":231}," '",[225,1069,232],{"class":273},[225,1071,1072],{"class":227,"line":302},[225,1073,1074],{"class":273},"    \"name\": \"Spring Promo 2026\",\n",[225,1076,1077],{"class":227,"line":319},[225,1078,1079],{"class":273},"    \"channel_id\": 5,\n",[225,1081,1082],{"class":227,"line":336},[225,1083,1084],{"class":273},"    \"messages\": [\n",[225,1086,1087],{"class":227,"line":353},[225,1088,1089],{"class":273},"      { \"type\": \"text\", \"content\": \"Hi! We have a special offer just for you 🎉\" },\n",[225,1091,1092],{"class":227,"line":370},[225,1093,1094],{"class":273},"      { \"type\": \"text\", \"content\": \"Reply YES to learn more, or STOP to unsubscribe.\" }\n",[225,1096,1097],{"class":227,"line":387},[225,1098,1099],{"class":273},"    ],\n",[225,1101,1102],{"class":227,"line":402},[225,1103,1104],{"class":273},"    \"list_ids\": [3, 7],\n",[225,1106,1107],{"class":227,"line":423},[225,1108,1109],{"class":273},"    \"is_new_number\": false\n",[225,1111,1112,1115],{"class":227,"line":438},[225,1113,1114],{"class":273},"  }",[225,1116,1117],{"class":231},"'\n",[162,1119,1120,1121,1124,1125,1127,1128,1131],{},"Returns ",[174,1122,1123],{},"201 Created",". The campaign starts in ",[179,1126,679],{}," status — call ",[179,1129,1130],{},"/start"," to begin sending.",[828,1133,1135],{"id":1134},"daily-limits","Daily limits",[162,1137,1138,1139,1141,1142,1144],{},"Daily message limits scale automatically based on ",[179,1140,358],{}," and ",[179,1143,392],{}," to protect your sending reputation:",[644,1146,1147,1160],{},[647,1148,1149],{},[650,1150,1151,1154,1157],{},[653,1152,1153],{},"Day",[653,1155,1156],{},"Normal number",[653,1158,1159],{},"New number",[663,1161,1162,1173,1184,1194,1205],{},[650,1163,1164,1167,1170],{},[668,1165,1166],{},"1",[668,1168,1169],{},"up to 35",[668,1171,1172],{},"up to 20",[650,1174,1175,1178,1181],{},[668,1176,1177],{},"3",[668,1179,1180],{},"up to 65",[668,1182,1183],{},"up to 40",[650,1185,1186,1189,1191],{},[668,1187,1188],{},"5",[668,1190,1180],{},[668,1192,1193],{},"up to 60",[650,1195,1196,1199,1202],{},[668,1197,1198],{},"7+",[668,1200,1201],{},"up to 120",[668,1203,1204],{},"up to 90",[650,1206,1207,1210,1213],{},[668,1208,1209],{},"14+",[668,1211,1212],{},"up to 200",[668,1214,1212],{},[162,1216,1217,1218,1221],{},"For small campaigns, the limit is capped at ",[179,1219,1220],{},"⌈total_contacts / 3⌉"," to finish in ~3 days.",[184,1223],{},[157,1225,1227],{"id":1226},"get-a-campaign","Get a campaign",[191,1229,1231],{"className":756,"code":1230,"language":758,"meta":199,"style":199},"GET /api/v1/campaigns/{id}\n",[179,1232,1233],{"__ignoreMap":199},[225,1234,1235],{"class":227,"line":228},[225,1236,1230],{},[184,1238],{},[157,1240,1242],{"id":1241},"update-a-campaign","Update a campaign",[191,1244,1246],{"className":756,"code":1245,"language":758,"meta":199,"style":199},"PUT /api/v1/campaigns/{id}\n",[179,1247,1248],{"__ignoreMap":199},[225,1249,1250],{"class":227,"line":228},[225,1251,1245],{},[162,1253,1254,1255,1257,1258,680,1260,1262,1263,182],{},"Only ",[174,1256,679],{}," campaigns can be updated. You can change ",[179,1259,263],{},[179,1261,886],{},", and ",[179,1264,392],{},[184,1266],{},[157,1268,1270],{"id":1269},"start-a-campaign","Start a campaign",[191,1272,1274],{"className":756,"code":1273,"language":758,"meta":199,"style":199},"POST /api/v1/campaigns/{id}/start\n",[179,1275,1276],{"__ignoreMap":199},[225,1277,1278],{"class":227,"line":228},[225,1279,1273],{},[162,1281,1282,1283,1285,1286,1288],{},"Transitions the campaign from ",[179,1284,679],{}," to ",[179,1287,295],{},". Sending begins on the next background job cycle.",[184,1290],{},[157,1292,1294],{"id":1293},"pause-a-campaign","Pause a campaign",[191,1296,1298],{"className":756,"code":1297,"language":758,"meta":199,"style":199},"POST /api/v1/campaigns/{id}/pause\n",[179,1299,1300],{"__ignoreMap":199},[225,1301,1302],{"class":227,"line":228},[225,1303,1297],{},[162,1305,1306],{},"Stops sending immediately. The campaign can be resumed at any time without losing progress.",[184,1308],{},[157,1310,1312],{"id":1311},"resume-a-campaign","Resume a campaign",[191,1314,1316],{"className":756,"code":1315,"language":758,"meta":199,"style":199},"POST /api/v1/campaigns/{id}/resume\n",[179,1317,1318],{"__ignoreMap":199},[225,1319,1320],{"class":227,"line":228},[225,1321,1315],{},[162,1323,1324,1325,1327,1328,182],{},"Transitions from ",[179,1326,685],{}," back to ",[179,1329,295],{},[184,1331],{},[157,1333,1335],{"id":1334},"cancel-a-campaign","Cancel a campaign",[191,1337,1339],{"className":756,"code":1338,"language":758,"meta":199,"style":199},"POST /api/v1/campaigns/{id}/cancel\n",[179,1340,1341],{"__ignoreMap":199},[225,1342,1343],{"class":227,"line":228},[225,1344,1338],{},[162,1346,1347],{},"Permanently stops the campaign. Cancelled campaigns cannot be restarted. Returns the updated campaign object.",[184,1349],{},[157,1351,1353],{"id":1352},"delete-a-campaign","Delete a campaign",[191,1355,1357],{"className":756,"code":1356,"language":758,"meta":199,"style":199},"DELETE /api/v1/campaigns/{id}\n",[179,1358,1359],{"__ignoreMap":199},[225,1360,1361],{"class":227,"line":228},[225,1362,1356],{},[162,1364,1254,1365,1367,1368,1370,1371,182],{},[179,1366,679],{}," or ",[179,1369,690],{}," campaigns can be deleted. Returns ",[174,1372,1373],{},"204 No Content",[184,1375],{},[157,1377,1379],{"id":1378},"list-campaign-contacts","List campaign contacts",[191,1381,1383],{"className":756,"code":1382,"language":758,"meta":199,"style":199},"GET /api/v1/campaigns/{id}/contacts\n",[179,1384,1385],{"__ignoreMap":199},[225,1386,1387],{"class":227,"line":228},[225,1388,1382],{},[162,1390,1391],{},"Returns the enrolled contacts and their delivery status.",[644,1393,1394,1404],{},[647,1395,1396],{},[650,1397,1398,1400,1402],{},[653,1399,773],{},[653,1401,658],{},[653,1403,661],{},[663,1405,1406,1425],{},[650,1407,1408,1412,1414],{},[668,1409,1410],{},[179,1411,286],{},[668,1413,674],{},[668,1415,1416,680,1419,680,1422],{},[179,1417,1418],{},"pending",[179,1420,1421],{},"sent",[179,1423,1424],{},"failed",[650,1426,1427,1431,1433],{},[668,1428,1429],{},[179,1430,806],{},[668,1432,699],{},[668,1434,1435],{},"Max 100",[191,1437,1439],{"className":219,"code":1438,"language":221,"meta":199,"style":199},"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"status\": \"sent\",\n      \"phone\": \"+966501234567\",\n      \"sent_at\": \"2026-03-05T09:14:00.000000Z\",\n      \"error\": null,\n      \"contact\": { \"id\": 42, \"name\": \"Noura Al-Otaibi\", \"type\": \"whatsapp\" }\n    }\n  ]\n}\n",[179,1440,1441,1445,1459,1473,1478,1494,1512,1532,1552,1565,1625,1630,1635],{"__ignoreMap":199},[225,1442,1443],{"class":227,"line":228},[225,1444,232],{"class":231},[225,1446,1447,1449,1452,1454,1456],{"class":227,"line":235},[225,1448,238],{"class":231},[225,1450,1451],{"class":241},"success",[225,1453,245],{"class":231},[225,1455,248],{"class":231},[225,1457,1458],{"class":231}," true,\n",[225,1460,1461,1463,1466,1468,1470],{"class":227,"line":258},[225,1462,238],{"class":231},[225,1464,1465],{"class":241},"data",[225,1467,245],{"class":231},[225,1469,248],{"class":231},[225,1471,1472],{"class":231}," [\n",[225,1474,1475],{"class":227,"line":281},[225,1476,1477],{"class":231},"    {\n",[225,1479,1480,1483,1485,1487,1489,1492],{"class":227,"line":302},[225,1481,1482],{"class":231},"      \"",[225,1484,242],{"class":505},[225,1486,245],{"class":231},[225,1488,248],{"class":231},[225,1490,1491],{"class":251}," 1",[225,1493,255],{"class":231},[225,1495,1496,1498,1500,1502,1504,1506,1508,1510],{"class":227,"line":319},[225,1497,1482],{"class":231},[225,1499,286],{"class":505},[225,1501,245],{"class":231},[225,1503,248],{"class":231},[225,1505,270],{"class":231},[225,1507,1421],{"class":273},[225,1509,245],{"class":231},[225,1511,255],{"class":231},[225,1513,1514,1516,1519,1521,1523,1525,1528,1530],{"class":227,"line":336},[225,1515,1482],{"class":231},[225,1517,1518],{"class":505},"phone",[225,1520,245],{"class":231},[225,1522,248],{"class":231},[225,1524,270],{"class":231},[225,1526,1527],{"class":273},"+966501234567",[225,1529,245],{"class":231},[225,1531,255],{"class":231},[225,1533,1534,1536,1539,1541,1543,1545,1548,1550],{"class":227,"line":353},[225,1535,1482],{"class":231},[225,1537,1538],{"class":505},"sent_at",[225,1540,245],{"class":231},[225,1542,248],{"class":231},[225,1544,270],{"class":231},[225,1546,1547],{"class":273},"2026-03-05T09:14:00.000000Z",[225,1549,245],{"class":231},[225,1551,255],{"class":231},[225,1553,1554,1556,1559,1561,1563],{"class":227,"line":370},[225,1555,1482],{"class":231},[225,1557,1558],{"class":505},"error",[225,1560,245],{"class":231},[225,1562,248],{"class":231},[225,1564,435],{"class":231},[225,1566,1567,1569,1572,1574,1576,1578,1580,1582,1584,1586,1589,1591,1593,1595,1597,1599,1601,1604,1606,1608,1610,1612,1614,1616,1618,1620,1622],{"class":227,"line":387},[225,1568,1482],{"class":231},[225,1570,1571],{"class":505},"contact",[225,1573,245],{"class":231},[225,1575,248],{"class":231},[225,1577,500],{"class":231},[225,1579,270],{"class":231},[225,1581,242],{"class":251},[225,1583,245],{"class":231},[225,1585,248],{"class":231},[225,1587,1588],{"class":251}," 42",[225,1590,515],{"class":231},[225,1592,270],{"class":231},[225,1594,263],{"class":251},[225,1596,245],{"class":231},[225,1598,248],{"class":231},[225,1600,270],{"class":231},[225,1602,1603],{"class":273},"Noura Al-Otaibi",[225,1605,245],{"class":231},[225,1607,515],{"class":231},[225,1609,270],{"class":231},[225,1611,537],{"class":251},[225,1613,245],{"class":231},[225,1615,248],{"class":231},[225,1617,270],{"class":231},[225,1619,546],{"class":273},[225,1621,245],{"class":231},[225,1623,1624],{"class":231}," }\n",[225,1626,1627],{"class":227,"line":402},[225,1628,1629],{"class":231},"    }\n",[225,1631,1632],{"class":227,"line":423},[225,1633,1634],{"class":231},"  ]\n",[225,1636,1637],{"class":227,"line":438},[225,1638,642],{"class":231},[1640,1641,1642],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}",{"title":199,"searchDepth":228,"depth":235,"links":1644},[1645,1646,1647,1648,1649,1653,1654,1655,1656,1657,1658,1659,1660],{"id":159,"depth":235,"text":160},{"id":188,"depth":235,"text":189},{"id":215,"depth":235,"text":216},{"id":752,"depth":235,"text":753},{"id":816,"depth":235,"text":817,"children":1650},[1651,1652],{"id":830,"depth":258,"text":831},{"id":1134,"depth":258,"text":1135},{"id":1226,"depth":235,"text":1227},{"id":1241,"depth":235,"text":1242},{"id":1269,"depth":235,"text":1270},{"id":1293,"depth":235,"text":1294},{"id":1311,"depth":235,"text":1312},{"id":1334,"depth":235,"text":1335},{"id":1352,"depth":235,"text":1353},{"id":1378,"depth":235,"text":1379},"Create and manage multi-day outreach campaigns across your connected messaging channels.","md",null,{},{"icon":47},{"title":44,"description":1661},"qKhG8OXdFHSJNgXb5BVejbheLxUrZlvZoA6Bwvfs370",[1669,1671],{"title":39,"path":40,"stem":41,"description":1670,"icon":42,"children":-1},"Create and manage AI agent personas that drive automated responses across all messaging channels.",{"title":49,"path":50,"stem":51,"description":1672,"icon":52,"children":-1},"Create and manage support tickets with your team.",1775834839470]