@epilot/sdk 2.0.0-beta.4 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (290) hide show
  1. package/LICENSE +21 -0
  2. package/dist/{access-token.d-BuXO-21p.d.cts → access-token.d-CnmUTOlq.d.cts} +1 -1
  3. package/dist/{access-token.d-BuXO-21p.d.ts → access-token.d-CnmUTOlq.d.ts} +1 -1
  4. package/dist/{address-suggestions.d-Cay0qOfA.d.cts → address-suggestions.d-_YwTOR-9.d.cts} +1 -1
  5. package/dist/{address-suggestions.d-Cay0qOfA.d.ts → address-suggestions.d-_YwTOR-9.d.ts} +1 -1
  6. package/dist/{address.d-D-oZY0rk.d.cts → address.d-CwAPOVxa.d.cts} +1 -1
  7. package/dist/{address.d-D-oZY0rk.d.ts → address.d-CwAPOVxa.d.ts} +1 -1
  8. package/dist/{ai-agents.d-B4_CZTCP.d.cts → ai-agents.d-OkXfr2bz.d.cts} +1 -1
  9. package/dist/{ai-agents.d-B4_CZTCP.d.ts → ai-agents.d-OkXfr2bz.d.ts} +1 -1
  10. package/dist/apis/access-token.d.cts +3 -3
  11. package/dist/apis/access-token.d.ts +3 -3
  12. package/dist/apis/address-suggestions.d.cts +3 -3
  13. package/dist/apis/address-suggestions.d.ts +3 -3
  14. package/dist/apis/address.d.cts +3 -3
  15. package/dist/apis/address.d.ts +3 -3
  16. package/dist/apis/ai-agents.d.cts +3 -3
  17. package/dist/apis/ai-agents.d.ts +3 -3
  18. package/dist/apis/app.d.cts +3 -3
  19. package/dist/apis/app.d.ts +3 -3
  20. package/dist/apis/audit-logs.d.cts +3 -3
  21. package/dist/apis/audit-logs.d.ts +3 -3
  22. package/dist/apis/automation.d.cts +3 -3
  23. package/dist/apis/automation.d.ts +3 -3
  24. package/dist/apis/billing.d.cts +3 -3
  25. package/dist/apis/billing.d.ts +3 -3
  26. package/dist/apis/blueprint-manifest.d.cts +3 -3
  27. package/dist/apis/blueprint-manifest.d.ts +3 -3
  28. package/dist/apis/consent.d.cts +3 -3
  29. package/dist/apis/consent.d.ts +3 -3
  30. package/dist/apis/customer-portal.cjs +1 -1
  31. package/dist/apis/customer-portal.d.cts +3 -3
  32. package/dist/apis/customer-portal.d.ts +3 -3
  33. package/dist/apis/customer-portal.js +1 -1
  34. package/dist/apis/dashboard.d.cts +3 -3
  35. package/dist/apis/dashboard.d.ts +3 -3
  36. package/dist/apis/data-management.d.cts +3 -3
  37. package/dist/apis/data-management.d.ts +3 -3
  38. package/dist/apis/deduplication.d.cts +3 -3
  39. package/dist/apis/deduplication.d.ts +3 -3
  40. package/dist/apis/design.d.cts +3 -3
  41. package/dist/apis/design.d.ts +3 -3
  42. package/dist/apis/document.d.cts +3 -3
  43. package/dist/apis/document.d.ts +3 -3
  44. package/dist/apis/email-settings.d.cts +3 -3
  45. package/dist/apis/email-settings.d.ts +3 -3
  46. package/dist/apis/email-template.d.cts +3 -3
  47. package/dist/apis/email-template.d.ts +3 -3
  48. package/dist/apis/entity-mapping.d.cts +3 -3
  49. package/dist/apis/entity-mapping.d.ts +3 -3
  50. package/dist/apis/entity.d.cts +3 -3
  51. package/dist/apis/entity.d.ts +3 -3
  52. package/dist/apis/environments.d.cts +3 -3
  53. package/dist/apis/environments.d.ts +3 -3
  54. package/dist/apis/erp-integration.cjs +1 -1
  55. package/dist/apis/erp-integration.d.cts +3 -3
  56. package/dist/apis/erp-integration.d.ts +3 -3
  57. package/dist/apis/erp-integration.js +1 -1
  58. package/dist/apis/event-catalog.d.cts +3 -3
  59. package/dist/apis/event-catalog.d.ts +3 -3
  60. package/dist/apis/file.d.cts +3 -3
  61. package/dist/apis/file.d.ts +3 -3
  62. package/dist/apis/iban.d.cts +3 -3
  63. package/dist/apis/iban.d.ts +3 -3
  64. package/dist/apis/journey.d.cts +3 -3
  65. package/dist/apis/journey.d.ts +3 -3
  66. package/dist/apis/kanban.d.cts +3 -3
  67. package/dist/apis/kanban.d.ts +3 -3
  68. package/dist/apis/message.d.cts +3 -3
  69. package/dist/apis/message.d.ts +3 -3
  70. package/dist/apis/metering.d.cts +3 -3
  71. package/dist/apis/metering.d.ts +3 -3
  72. package/dist/apis/notes.d.cts +3 -3
  73. package/dist/apis/notes.d.ts +3 -3
  74. package/dist/apis/notification.d.cts +3 -3
  75. package/dist/apis/notification.d.ts +3 -3
  76. package/dist/apis/organization.cjs +1 -1
  77. package/dist/apis/organization.d.cts +3 -3
  78. package/dist/apis/organization.d.ts +3 -3
  79. package/dist/apis/organization.js +1 -1
  80. package/dist/apis/partner-directory.d.cts +3 -3
  81. package/dist/apis/partner-directory.d.ts +3 -3
  82. package/dist/apis/permissions.d.cts +3 -3
  83. package/dist/apis/permissions.d.ts +3 -3
  84. package/dist/apis/pricing-tier.d.cts +3 -3
  85. package/dist/apis/pricing-tier.d.ts +3 -3
  86. package/dist/apis/pricing.d.cts +3 -3
  87. package/dist/apis/pricing.d.ts +3 -3
  88. package/dist/apis/purpose.d.cts +3 -3
  89. package/dist/apis/purpose.d.ts +3 -3
  90. package/dist/apis/sandbox.d.cts +3 -3
  91. package/dist/apis/sandbox.d.ts +3 -3
  92. package/dist/apis/submission.d.cts +3 -3
  93. package/dist/apis/submission.d.ts +3 -3
  94. package/dist/apis/targeting.d.cts +3 -3
  95. package/dist/apis/targeting.d.ts +3 -3
  96. package/dist/apis/template-variables.d.cts +3 -3
  97. package/dist/apis/template-variables.d.ts +3 -3
  98. package/dist/apis/user.d.cts +3 -3
  99. package/dist/apis/user.d.ts +3 -3
  100. package/dist/apis/validation-rules.d.cts +3 -3
  101. package/dist/apis/validation-rules.d.ts +3 -3
  102. package/dist/apis/webhooks.d.cts +3 -3
  103. package/dist/apis/webhooks.d.ts +3 -3
  104. package/dist/apis/workflow-definition.d.cts +3 -3
  105. package/dist/apis/workflow-definition.d.ts +3 -3
  106. package/dist/apis/workflow.d.cts +3 -3
  107. package/dist/apis/workflow.d.ts +3 -3
  108. package/dist/{app.d-BKyfin-q.d.cts → app.d-Dr03n4J4.d.cts} +1 -1
  109. package/dist/{app.d-BKyfin-q.d.ts → app.d-Dr03n4J4.d.ts} +1 -1
  110. package/dist/{audit-logs.d-19BKb-ur.d.cts → audit-logs.d-BRToFqeX.d.cts} +1 -1
  111. package/dist/{audit-logs.d-19BKb-ur.d.ts → audit-logs.d-BRToFqeX.d.ts} +1 -1
  112. package/dist/{automation.d-DKl2VtnW.d.ts → automation.d-KOiZ6ru5.d.cts} +2 -24
  113. package/dist/{automation.d-DKl2VtnW.d.cts → automation.d-KOiZ6ru5.d.ts} +2 -24
  114. package/dist/{billing.d-58fUMBqj.d.cts → billing.d-Bs8Ku9qE.d.cts} +1 -1
  115. package/dist/{billing.d-58fUMBqj.d.ts → billing.d-Bs8Ku9qE.d.ts} +1 -1
  116. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.cts → blueprint-manifest.d-CEWRdF3i.d.cts} +1 -1
  117. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.ts → blueprint-manifest.d-CEWRdF3i.d.ts} +1 -1
  118. package/dist/{consent.d-CQ88IEj0.d.cts → consent.d-C2PROHhX.d.cts} +1 -1
  119. package/dist/{consent.d-CQ88IEj0.d.ts → consent.d-C2PROHhX.d.ts} +1 -1
  120. package/dist/{customer-portal.d-EyndRWh6.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  121. package/dist/{customer-portal.d-EyndRWh6.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  122. package/dist/{dashboard.d-AE3RQ6zo.d.cts → dashboard.d-CsGcA74I.d.cts} +1 -1
  123. package/dist/{dashboard.d-AE3RQ6zo.d.ts → dashboard.d-CsGcA74I.d.ts} +1 -1
  124. package/dist/{data-management.d-CNExsqJQ.d.cts → data-management.d-pnuiRU2h.d.cts} +1 -1
  125. package/dist/{data-management.d-CNExsqJQ.d.ts → data-management.d-pnuiRU2h.d.ts} +1 -1
  126. package/dist/{deduplication.d-DCeJzdbM.d.ts → deduplication.d-w_2aJD5f.d.cts} +1 -1
  127. package/dist/{deduplication.d-DCeJzdbM.d.cts → deduplication.d-w_2aJD5f.d.ts} +1 -1
  128. package/dist/{design.d-CkwgJ78Z.d.cts → design.d-eA-irKEX.d.cts} +1 -1
  129. package/dist/{design.d-CkwgJ78Z.d.ts → design.d-eA-irKEX.d.ts} +1 -1
  130. package/dist/{document.d-Y8i32qNV.d.cts → document.d-DN37pjdx.d.cts} +1 -1
  131. package/dist/{document.d-Y8i32qNV.d.ts → document.d-DN37pjdx.d.ts} +1 -1
  132. package/dist/{email-settings.d-CPAsRFWN.d.cts → email-settings.d-BXxYjVDr.d.cts} +1 -1
  133. package/dist/{email-settings.d-CPAsRFWN.d.ts → email-settings.d-BXxYjVDr.d.ts} +1 -1
  134. package/dist/{email-template.d-CQqiCN0N.d.cts → email-template.d-BeqkDHtk.d.cts} +1 -1
  135. package/dist/{email-template.d-CQqiCN0N.d.ts → email-template.d-BeqkDHtk.d.ts} +1 -1
  136. package/dist/{entity-mapping.d-DiqXqJWb.d.cts → entity-mapping.d-DKSW3sfy.d.cts} +1 -1
  137. package/dist/{entity-mapping.d-DiqXqJWb.d.ts → entity-mapping.d-DKSW3sfy.d.ts} +1 -1
  138. package/dist/{entity.d-BtT4mdq4.d.ts → entity.d-CrtZaZr8.d.cts} +1 -1
  139. package/dist/{entity.d-BtT4mdq4.d.cts → entity.d-CrtZaZr8.d.ts} +1 -1
  140. package/dist/{environments.d-C1xIs8N2.d.cts → environments.d-H3LK_KuH.d.cts} +1 -1
  141. package/dist/{environments.d-C1xIs8N2.d.ts → environments.d-H3LK_KuH.d.ts} +1 -1
  142. package/dist/{erp-integration.d-CNLzgl4L.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  143. package/dist/{erp-integration.d-CNLzgl4L.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  144. package/dist/{event-catalog.d-DW1dOyVh.d.cts → event-catalog.d-ENw6HO-w.d.cts} +1 -1
  145. package/dist/{event-catalog.d-DW1dOyVh.d.ts → event-catalog.d-ENw6HO-w.d.ts} +1 -1
  146. package/dist/{file.d-Bpdt2ORN.d.cts → file.d-DcTJxjp7.d.cts} +1 -1
  147. package/dist/{file.d-Bpdt2ORN.d.ts → file.d-DcTJxjp7.d.ts} +1 -1
  148. package/dist/{iban.d-3_7FEsbx.d.ts → iban.d-BwdiGbxi.d.cts} +1 -1
  149. package/dist/{iban.d-3_7FEsbx.d.cts → iban.d-BwdiGbxi.d.ts} +1 -1
  150. package/dist/index.d.cts +46 -46
  151. package/dist/index.d.ts +46 -46
  152. package/dist/{journey.d-C2lgynUF.d.cts → journey.d-C4N4t1Rh.d.cts} +122 -4
  153. package/dist/{journey.d-C2lgynUF.d.ts → journey.d-C4N4t1Rh.d.ts} +122 -4
  154. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  155. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  156. package/dist/{message.d-TAVDRlDJ.d.cts → message.d-YEv1kmQd.d.cts} +1 -1
  157. package/dist/{message.d-TAVDRlDJ.d.ts → message.d-YEv1kmQd.d.ts} +1 -1
  158. package/dist/{metering.d-qyYaAU-O.d.cts → metering.d-DvtPv7wk.d.cts} +1 -1
  159. package/dist/{metering.d-qyYaAU-O.d.ts → metering.d-DvtPv7wk.d.ts} +1 -1
  160. package/dist/{notes.d-CDyIbegf.d.cts → notes.d-BC-scR42.d.cts} +1 -1
  161. package/dist/{notes.d-CDyIbegf.d.ts → notes.d-BC-scR42.d.ts} +1 -1
  162. package/dist/{notification.d-B7ccbaPr.d.cts → notification.d-BfBL3lga.d.cts} +1 -1
  163. package/dist/{notification.d-B7ccbaPr.d.ts → notification.d-BfBL3lga.d.ts} +1 -1
  164. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  165. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  166. package/dist/{partner-directory.d-CzKV3WfP.d.cts → partner-directory.d-CRNkDF8q.d.cts} +1 -1
  167. package/dist/{partner-directory.d-CzKV3WfP.d.ts → partner-directory.d-CRNkDF8q.d.ts} +1 -1
  168. package/dist/{permissions.d-lVoPAfl3.d.cts → permissions.d-BHB1FFS5.d.cts} +1 -1
  169. package/dist/{permissions.d-lVoPAfl3.d.ts → permissions.d-BHB1FFS5.d.ts} +1 -1
  170. package/dist/{pricing-tier.d-BW2cZt1w.d.cts → pricing-tier.d-Cg0jl6n_.d.cts} +1 -1
  171. package/dist/{pricing-tier.d-BW2cZt1w.d.ts → pricing-tier.d-Cg0jl6n_.d.ts} +1 -1
  172. package/dist/{pricing.d-Ehb2JuKY.d.cts → pricing.d-Cv39plGm.d.cts} +1 -1
  173. package/dist/{pricing.d-Ehb2JuKY.d.ts → pricing.d-Cv39plGm.d.ts} +1 -1
  174. package/dist/{purpose.d-BVxst611.d.cts → purpose.d-CbIYfTua.d.cts} +1 -1
  175. package/dist/{purpose.d-BVxst611.d.ts → purpose.d-CbIYfTua.d.ts} +1 -1
  176. package/dist/{sandbox.d-tRO2movo.d.cts → sandbox.d-BdbOFzDu.d.cts} +1 -1
  177. package/dist/{sandbox.d-tRO2movo.d.ts → sandbox.d-BdbOFzDu.d.ts} +1 -1
  178. package/dist/{submission.d-CSll5Km9.d.cts → submission.d-BamwfhXw.d.cts} +1 -1
  179. package/dist/{submission.d-CSll5Km9.d.ts → submission.d-BamwfhXw.d.ts} +1 -1
  180. package/dist/{targeting.d-CDxIsOWy.d.cts → targeting.d-BNmcVsNS.d.cts} +1 -1
  181. package/dist/{targeting.d-CDxIsOWy.d.ts → targeting.d-BNmcVsNS.d.ts} +1 -1
  182. package/dist/{template-variables.d-PwA27Ocv.d.cts → template-variables.d-Ch3H3zYf.d.cts} +1 -1
  183. package/dist/{template-variables.d-PwA27Ocv.d.ts → template-variables.d-Ch3H3zYf.d.ts} +1 -1
  184. package/dist/{user.d-DJBp6aX5.d.cts → user.d-CXqM751M.d.cts} +1 -1
  185. package/dist/{user.d-DJBp6aX5.d.ts → user.d-CXqM751M.d.ts} +1 -1
  186. package/dist/{validation-rules.d-CScjNdxD.d.cts → validation-rules.d-Db5c5zTf.d.cts} +1 -1
  187. package/dist/{validation-rules.d-CScjNdxD.d.ts → validation-rules.d-Db5c5zTf.d.ts} +1 -1
  188. package/dist/{webhooks.d-C_MQSJEB.d.cts → webhooks.d-CUNJrltY.d.cts} +1 -1
  189. package/dist/{webhooks.d-C_MQSJEB.d.ts → webhooks.d-CUNJrltY.d.ts} +1 -1
  190. package/dist/{workflow-definition.d-CFXrp2Hg.d.cts → workflow-definition.d-CE3kk9gl.d.cts} +1 -1
  191. package/dist/{workflow-definition.d-CFXrp2Hg.d.ts → workflow-definition.d-CE3kk9gl.d.ts} +1 -1
  192. package/dist/{workflow.d-BIWtgMyP.d.cts → workflow.d-DvhTpEtU.d.cts} +46 -4
  193. package/dist/{workflow.d-BIWtgMyP.d.ts → workflow.d-DvhTpEtU.d.ts} +46 -4
  194. package/package.json +152 -11
  195. package/definitions/access-token-runtime.json +0 -1
  196. package/definitions/access-token.json +0 -663
  197. package/definitions/address-runtime.json +0 -1
  198. package/definitions/address-suggestions-runtime.json +0 -1
  199. package/definitions/address-suggestions.json +0 -582
  200. package/definitions/address.json +0 -578
  201. package/definitions/ai-agents-runtime.json +0 -1
  202. package/definitions/ai-agents.json +0 -1711
  203. package/definitions/app-runtime.json +0 -1
  204. package/definitions/app.json +0 -4443
  205. package/definitions/audit-logs-runtime.json +0 -1
  206. package/definitions/audit-logs.json +0 -305
  207. package/definitions/automation-runtime.json +0 -1
  208. package/definitions/automation.json +0 -4850
  209. package/definitions/billing-runtime.json +0 -1
  210. package/definitions/billing.json +0 -837
  211. package/definitions/blueprint-manifest-runtime.json +0 -1
  212. package/definitions/blueprint-manifest.json +0 -3376
  213. package/definitions/consent-runtime.json +0 -1
  214. package/definitions/consent.json +0 -344
  215. package/definitions/customer-portal-runtime.json +0 -1
  216. package/definitions/customer-portal.json +0 -15000
  217. package/definitions/dashboard-runtime.json +0 -1
  218. package/definitions/dashboard.json +0 -484
  219. package/definitions/data-management-runtime.json +0 -1
  220. package/definitions/data-management.json +0 -962
  221. package/definitions/deduplication-runtime.json +0 -1
  222. package/definitions/deduplication.json +0 -183
  223. package/definitions/design-runtime.json +0 -1
  224. package/definitions/design.json +0 -1423
  225. package/definitions/document-runtime.json +0 -1
  226. package/definitions/document.json +0 -758
  227. package/definitions/email-settings-runtime.json +0 -1
  228. package/definitions/email-settings.json +0 -2627
  229. package/definitions/email-template-runtime.json +0 -1
  230. package/definitions/email-template.json +0 -1419
  231. package/definitions/entity-mapping-runtime.json +0 -1
  232. package/definitions/entity-mapping.json +0 -1642
  233. package/definitions/entity-runtime.json +0 -1
  234. package/definitions/entity.json +0 -10074
  235. package/definitions/environments-runtime.json +0 -1
  236. package/definitions/environments.json +0 -363
  237. package/definitions/erp-integration-runtime.json +0 -1
  238. package/definitions/erp-integration.json +0 -5845
  239. package/definitions/event-catalog-runtime.json +0 -1
  240. package/definitions/event-catalog.json +0 -1051
  241. package/definitions/file-runtime.json +0 -1
  242. package/definitions/file.json +0 -2842
  243. package/definitions/iban-runtime.json +0 -1
  244. package/definitions/iban.json +0 -132
  245. package/definitions/journey-runtime.json +0 -1
  246. package/definitions/journey.json +0 -2341
  247. package/definitions/kanban-runtime.json +0 -1
  248. package/definitions/kanban.json +0 -929
  249. package/definitions/message-runtime.json +0 -1
  250. package/definitions/message.json +0 -2660
  251. package/definitions/metering-runtime.json +0 -1
  252. package/definitions/metering.json +0 -2321
  253. package/definitions/notes-runtime.json +0 -1
  254. package/definitions/notes.json +0 -1531
  255. package/definitions/notification-runtime.json +0 -1
  256. package/definitions/notification.json +0 -1425
  257. package/definitions/organization-runtime.json +0 -1
  258. package/definitions/organization.json +0 -629
  259. package/definitions/partner-directory-runtime.json +0 -1
  260. package/definitions/partner-directory.json +0 -1718
  261. package/definitions/permissions-runtime.json +0 -1
  262. package/definitions/permissions.json +0 -1480
  263. package/definitions/pricing-runtime.json +0 -1
  264. package/definitions/pricing-tier-runtime.json +0 -1
  265. package/definitions/pricing-tier.json +0 -105
  266. package/definitions/pricing.json +0 -9884
  267. package/definitions/purpose-runtime.json +0 -1
  268. package/definitions/purpose.json +0 -524
  269. package/definitions/sandbox-runtime.json +0 -1
  270. package/definitions/sandbox.json +0 -453
  271. package/definitions/submission-runtime.json +0 -1
  272. package/definitions/submission.json +0 -313
  273. package/definitions/targeting-runtime.json +0 -1
  274. package/definitions/targeting.json +0 -1474
  275. package/definitions/template-variables-runtime.json +0 -1
  276. package/definitions/template-variables.json +0 -1408
  277. package/definitions/user-runtime.json +0 -1
  278. package/definitions/user.json +0 -2408
  279. package/definitions/validation-rules-runtime.json +0 -1
  280. package/definitions/validation-rules.json +0 -1491
  281. package/definitions/webhooks-runtime.json +0 -1
  282. package/definitions/webhooks.json +0 -1525
  283. package/definitions/workflow-definition-runtime.json +0 -1
  284. package/definitions/workflow-definition.json +0 -3417
  285. package/definitions/workflow-runtime.json +0 -1
  286. package/definitions/workflow.json +0 -4106
  287. package/dist/kanban.d-DYVjUQ_S.d.cts +0 -630
  288. package/dist/kanban.d-DYVjUQ_S.d.ts +0 -630
  289. package/dist/organization.d-BxZWnh8L.d.cts +0 -628
  290. package/dist/organization.d-BxZWnh8L.d.ts +0 -628
@@ -1,2627 +0,0 @@
1
- {
2
- "openapi": "3.0.3",
3
- "info": {
4
- "title": "Messaging Settings API",
5
- "version": "1.5.0",
6
- "description": "The Messaging Settings API provides comprehensive management of email configurations for epilot organizations.\n\n## Overview\n\nThis API enables organizations to:\n- **Email Addresses**: Configure sender email addresses, set primary addresses, and manage email aliases\n- **Email Signatures**: Create and manage HTML email signatures that can be associated with email addresses\n- **Custom Domains**: Add and verify custom email domains for professional branding\n- **Shared Inboxes**: Organize incoming emails into categorized inboxes with team assignments\n- **Microsoft 365 Integration**: Connect Outlook mailboxes for seamless email synchronization\n\n## Key Concepts\n\n### Email Addresses\nEmail addresses represent the sender identities used when composing emails. Each address can have:\n- A display name (e.g., \"Sales Team\")\n- Assigned users and groups who can send from this address\n- A default signature\n- Association with a shared inbox\n\n### Shared Inboxes\nShared inboxes help teams organize and manage incoming emails. Features include:\n- Color-coded categorization\n- Team member assignments\n- Routing rules for incoming messages\n\n### Email Signatures\nHTML signatures that are automatically appended to outgoing emails. Signatures can include:\n- Rich text formatting\n- Images and logos\n- Contact information\n\n### Custom Domains\nOrganizations can configure custom email domains to send emails from their own domain (e.g., `support@yourcompany.com`). This requires:\n1. Adding the domain\n2. Configuring DNS records\n3. Verifying domain ownership\n\n## Authentication\n\nAll endpoints require authentication via Bearer token (JWT) unless otherwise specified.\nUse the `x-epilot-org-id` header to specify the target organization when using shared tenant access.\n"
7
- },
8
- "tags": [
9
- {
10
- "name": "Email settings",
11
- "description": "Legacy settings endpoints for managing various email configuration types including signatures,\ncustom domains, email addresses, and duplicate detection settings.\n"
12
- },
13
- {
14
- "name": "Email addresses",
15
- "description": "Manage email sender addresses for your organization. Email addresses define the identities\nfrom which emails can be sent. Each address can be configured with display names, user/group\nassignments, default signatures, and shared inbox associations.\n"
16
- },
17
- {
18
- "name": "Shared inboxes",
19
- "description": "Shared inboxes provide team-based email organization. They allow multiple users to collaborate\non incoming messages with features like color-coding, assignee management, and email routing.\nA default inbox is always available and does not need to be explicitly created.\n"
20
- },
21
- {
22
- "name": "Inbox buckets",
23
- "description": "Inbox buckets are internal storage containers associated with shared inboxes. Each shared inbox\nhas a corresponding bucket for message storage. The default bucket is always available.\n"
24
- },
25
- {
26
- "name": "O365 Outlook Connection",
27
- "description": "Microsoft Office 365 Outlook integration endpoints. These endpoints enable organizations to:\n- Initiate OAuth connections with Microsoft 365\n- Connect Outlook shared mailboxes\n- Manage connection status and tokens\n- Disconnect integrations when needed\n\nThe integration supports multiple Azure AD tenants and handles token refresh automatically.\n"
28
- },
29
- {
30
- "name": "Settings",
31
- "description": "Generic settings management for various email configuration types:\n- **signature**: HTML email signatures\n- **email_domain**: Custom email domains\n- **email_address**: Sender email addresses\n- **whitelist_email_address**: Addresses exempt from duplicate detection\n- **restrict_duplicates_within**: Time window for duplicate email detection\n"
32
- },
33
- {
34
- "name": "Domains",
35
- "description": "Custom email domain management. Add, verify, and configure custom domains to send emails\nfrom your organization's domain. Domain verification requires proper DNS configuration\nincluding MX records and SPF/DKIM settings.\n"
36
- }
37
- ],
38
- "security": [
39
- {
40
- "EpilotAuth": []
41
- },
42
- {
43
- "AsOrganization": []
44
- },
45
- {
46
- "EpilotOrg": []
47
- }
48
- ],
49
- "paths": {
50
- "/v2/email-settings/email-addresses/epilot:provision": {
51
- "put": {
52
- "operationId": "provisionEpilotEmailAddress",
53
- "summary": "provisionEpilotEmailAddress",
54
- "description": "Provisions or reactivates an epilot-managed email address for the organization.\n\nWhen provisioning a new epilot email address, any previously active epilot email addresses\nwill be automatically deactivated. Only one epilot email address can be active at a time.\n\nEpilot email addresses use the `@epilot.cloud` domain and are fully managed by the platform.\n",
55
- "tags": [
56
- "Email addresses"
57
- ],
58
- "requestBody": {
59
- "description": "The epilot email address to provision",
60
- "required": true,
61
- "content": {
62
- "application/json": {
63
- "schema": {
64
- "$ref": "#/components/schemas/ProvisionEpilotEmailAddressPayload"
65
- },
66
- "example": {
67
- "address": "mycompany@epilot.cloud"
68
- }
69
- }
70
- }
71
- },
72
- "responses": {
73
- "200": {
74
- "$ref": "#/components/responses/ProvisionEpilotEmailAddressSuccessResponse"
75
- },
76
- "400": {
77
- "$ref": "#/components/responses/BadRequest"
78
- },
79
- "409": {
80
- "$ref": "#/components/responses/Conflict"
81
- },
82
- "500": {
83
- "$ref": "#/components/responses/InternalServerError"
84
- }
85
- }
86
- }
87
- },
88
- "/v2/email-settings/email-addresses/primary": {
89
- "post": {
90
- "operationId": "setEmailAddressPrimary",
91
- "summary": "setEmailAddressPrimary",
92
- "description": "Sets the specified email address as the primary address for the organization.\n\nThe primary email address is used as the default sender address when composing new emails.\nOnly one email address can be primary at a time; setting a new primary will unset the previous one.\n",
93
- "tags": [
94
- "Email addresses"
95
- ],
96
- "requestBody": {
97
- "description": "The email address to set as primary",
98
- "required": true,
99
- "content": {
100
- "application/json": {
101
- "schema": {
102
- "$ref": "#/components/schemas/SetEmailAddressPrimaryPayload"
103
- },
104
- "example": {
105
- "address": "sales@yourcompany.com"
106
- }
107
- }
108
- }
109
- },
110
- "responses": {
111
- "200": {
112
- "$ref": "#/components/responses/SetEmailAddressPrimarySuccessResponse"
113
- },
114
- "400": {
115
- "$ref": "#/components/responses/BadRequest"
116
- },
117
- "403": {
118
- "$ref": "#/components/responses/Forbidden"
119
- },
120
- "409": {
121
- "$ref": "#/components/responses/Conflict"
122
- },
123
- "500": {
124
- "$ref": "#/components/responses/InternalServerError"
125
- }
126
- }
127
- }
128
- },
129
- "/v2/email-settings/email-addresses/{id}": {
130
- "get": {
131
- "operationId": "getEmailAddress",
132
- "summary": "getEmailAddress",
133
- "description": "Retrieves the details of a specific email address by its ID.\n\nReturns the full configuration including display name, assigned users/groups,\ndefault signature, and shared inbox association.\n",
134
- "tags": [
135
- "Email addresses"
136
- ],
137
- "parameters": [
138
- {
139
- "$ref": "#/components/parameters/EmailAddressId"
140
- }
141
- ],
142
- "responses": {
143
- "200": {
144
- "$ref": "#/components/responses/GetEmailAddressSuccessResponse"
145
- },
146
- "403": {
147
- "$ref": "#/components/responses/Forbidden"
148
- },
149
- "404": {
150
- "$ref": "#/components/responses/NotFound"
151
- },
152
- "500": {
153
- "$ref": "#/components/responses/InternalServerError"
154
- }
155
- }
156
- },
157
- "delete": {
158
- "operationId": "deleteEmailAddress",
159
- "summary": "deleteEmailAddress",
160
- "description": "Permanently deletes an email address from the organization.\n\n**Warning**: This action cannot be undone. Users will no longer be able to send\nemails from this address after deletion.\n",
161
- "tags": [
162
- "Email addresses"
163
- ],
164
- "parameters": [
165
- {
166
- "$ref": "#/components/parameters/EmailAddressId"
167
- }
168
- ],
169
- "responses": {
170
- "204": {
171
- "$ref": "#/components/responses/NoContent"
172
- },
173
- "403": {
174
- "$ref": "#/components/responses/Forbidden"
175
- },
176
- "404": {
177
- "$ref": "#/components/responses/NotFound"
178
- },
179
- "500": {
180
- "$ref": "#/components/responses/InternalServerError"
181
- }
182
- }
183
- },
184
- "put": {
185
- "operationId": "updateEmailAddress",
186
- "summary": "updateEmailAddress",
187
- "description": "Updates the configuration of an existing email address.\n\nYou can modify:\n- Display name\n- Assigned users and groups\n- Default signature\n- Shared inbox association\n- Active status\n",
188
- "tags": [
189
- "Email addresses"
190
- ],
191
- "parameters": [
192
- {
193
- "$ref": "#/components/parameters/EmailAddressId"
194
- }
195
- ],
196
- "requestBody": {
197
- "description": "The fields to update on the email address",
198
- "content": {
199
- "application/json": {
200
- "schema": {
201
- "$ref": "#/components/schemas/UpdateEmailAddressPayload"
202
- },
203
- "example": {
204
- "name": "Sales Team",
205
- "user_ids": [
206
- "user-123",
207
- "user-456"
208
- ],
209
- "default_signature_id": "sig-789",
210
- "is_active": true
211
- }
212
- }
213
- }
214
- },
215
- "responses": {
216
- "200": {
217
- "$ref": "#/components/responses/UpdateEmailAddressSuccessResponse"
218
- },
219
- "400": {
220
- "$ref": "#/components/responses/BadRequest"
221
- },
222
- "403": {
223
- "$ref": "#/components/responses/Forbidden"
224
- },
225
- "404": {
226
- "$ref": "#/components/responses/NotFound"
227
- },
228
- "409": {
229
- "$ref": "#/components/responses/Conflict"
230
- },
231
- "500": {
232
- "$ref": "#/components/responses/InternalServerError"
233
- }
234
- }
235
- }
236
- },
237
- "/v2/email-settings/email-addresses": {
238
- "get": {
239
- "operationId": "listEmailAddresses",
240
- "summary": "listEmailAddresses",
241
- "description": "Retrieves all email addresses configured for the organization.\n\nReturns an array of email address configurations including their IDs, display names,\nassigned users/groups, signatures, and status flags.\n",
242
- "tags": [
243
- "Email addresses"
244
- ],
245
- "responses": {
246
- "200": {
247
- "$ref": "#/components/responses/ListEmailAddressesSuccessResponse"
248
- },
249
- "403": {
250
- "$ref": "#/components/responses/Forbidden"
251
- },
252
- "500": {
253
- "$ref": "#/components/responses/InternalServerError"
254
- }
255
- }
256
- },
257
- "post": {
258
- "operationId": "addEmailAddress",
259
- "summary": "addEmailAddress",
260
- "description": "Adds a new email address to the organization.\n\nThe email address can be from a custom domain (if configured) or any external\nemail provider. Optionally assign users, groups, and a default signature.\n",
261
- "tags": [
262
- "Email addresses"
263
- ],
264
- "requestBody": {
265
- "description": "The email address configuration to create",
266
- "required": true,
267
- "content": {
268
- "application/json": {
269
- "schema": {
270
- "$ref": "#/components/schemas/CreateEmailAddressPayload"
271
- },
272
- "example": {
273
- "address": "support@yourcompany.com",
274
- "name": "Customer Support",
275
- "user_ids": [
276
- "user-123"
277
- ],
278
- "group_ids": [
279
- "group-456"
280
- ],
281
- "default_signature_id": "sig-789",
282
- "shared_inbox_id": "inbox-abc"
283
- }
284
- }
285
- }
286
- },
287
- "responses": {
288
- "201": {
289
- "$ref": "#/components/responses/CreateEmailAddressSuccessResponse"
290
- },
291
- "400": {
292
- "$ref": "#/components/responses/BadRequest"
293
- },
294
- "403": {
295
- "$ref": "#/components/responses/Forbidden"
296
- },
297
- "409": {
298
- "$ref": "#/components/responses/Conflict"
299
- },
300
- "500": {
301
- "$ref": "#/components/responses/InternalServerError"
302
- }
303
- }
304
- }
305
- },
306
- "/v2/email-settings/shared-inboxes/{id}": {
307
- "get": {
308
- "operationId": "getSharedInbox",
309
- "summary": "getSharedInbox",
310
- "description": "Retrieves the details of a specific shared inbox by its ID.\n\nReturns the inbox configuration including name, color, description, assigned team members,\nand the associated bucket ID.\n",
311
- "tags": [
312
- "Shared inboxes"
313
- ],
314
- "parameters": [
315
- {
316
- "$ref": "#/components/parameters/SharedInboxId"
317
- }
318
- ],
319
- "responses": {
320
- "200": {
321
- "$ref": "#/components/responses/GetSharedInboxSuccessResponse"
322
- },
323
- "403": {
324
- "$ref": "#/components/responses/Forbidden"
325
- },
326
- "404": {
327
- "$ref": "#/components/responses/NotFound"
328
- },
329
- "500": {
330
- "$ref": "#/components/responses/InternalServerError"
331
- }
332
- }
333
- },
334
- "delete": {
335
- "operationId": "deleteSharedInbox",
336
- "summary": "deleteSharedInbox",
337
- "description": "Deletes a shared inbox and reroutes all associated emails to a successor inbox.\n\nWhen a shared inbox is deleted:\n- All email addresses associated with this inbox will be reassigned to the successor\n- If no successor is specified, emails are routed to the default inbox\n- The inbox's message history is preserved in the successor inbox\n\n**Note**: The default inbox cannot be deleted.\n",
338
- "tags": [
339
- "Shared inboxes"
340
- ],
341
- "parameters": [
342
- {
343
- "$ref": "#/components/parameters/SharedInboxId"
344
- },
345
- {
346
- "name": "successorInboxId",
347
- "description": "ID of the inbox that will receive emails from the deleted inbox.\nIf not provided, the default inbox (`default`) will be used as the successor.\n",
348
- "in": "query",
349
- "required": false,
350
- "schema": {
351
- "type": "string"
352
- },
353
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
354
- }
355
- ],
356
- "responses": {
357
- "204": {
358
- "$ref": "#/components/responses/NoContent"
359
- },
360
- "400": {
361
- "$ref": "#/components/responses/BadRequest"
362
- },
363
- "403": {
364
- "$ref": "#/components/responses/Forbidden"
365
- },
366
- "404": {
367
- "$ref": "#/components/responses/NotFound"
368
- },
369
- "500": {
370
- "$ref": "#/components/responses/InternalServerError"
371
- }
372
- }
373
- },
374
- "put": {
375
- "operationId": "updateSharedInbox",
376
- "summary": "updateSharedInbox",
377
- "description": "Updates the configuration of an existing shared inbox.\n\nYou can modify the inbox name, color, description, and team member assignments.\nChanges take effect immediately for all associated email addresses.\n",
378
- "tags": [
379
- "Shared inboxes"
380
- ],
381
- "parameters": [
382
- {
383
- "$ref": "#/components/parameters/SharedInboxId"
384
- }
385
- ],
386
- "requestBody": {
387
- "description": "The fields to update on the shared inbox",
388
- "content": {
389
- "application/json": {
390
- "schema": {
391
- "$ref": "#/components/schemas/UpdateSharedInboxPayload"
392
- },
393
- "example": {
394
- "name": "Customer Support",
395
- "color": "#4CAF50",
396
- "description": "Incoming customer support requests",
397
- "assignees": [
398
- "user-123",
399
- "user-456"
400
- ]
401
- }
402
- }
403
- }
404
- },
405
- "responses": {
406
- "200": {
407
- "$ref": "#/components/responses/UpdateSharedInboxSuccessResponse"
408
- },
409
- "400": {
410
- "$ref": "#/components/responses/BadRequest"
411
- },
412
- "403": {
413
- "$ref": "#/components/responses/Forbidden"
414
- },
415
- "404": {
416
- "$ref": "#/components/responses/NotFound"
417
- },
418
- "409": {
419
- "$ref": "#/components/responses/Conflict"
420
- },
421
- "500": {
422
- "$ref": "#/components/responses/InternalServerError"
423
- }
424
- }
425
- }
426
- },
427
- "/v2/email-settings/shared-inboxes": {
428
- "get": {
429
- "operationId": "listSharedInboxes",
430
- "summary": "listSharedInboxes",
431
- "description": "Retrieves all shared inboxes configured for the organization.\n\n**Note**: The default inbox (with ID `default`) is not included in this list but is\nalways available for all organizations. You do not need to create it explicitly.\n",
432
- "tags": [
433
- "Shared inboxes"
434
- ],
435
- "responses": {
436
- "200": {
437
- "$ref": "#/components/responses/ListSharedInboxesSuccessResponse"
438
- },
439
- "403": {
440
- "$ref": "#/components/responses/Forbidden"
441
- },
442
- "500": {
443
- "$ref": "#/components/responses/InternalServerError"
444
- }
445
- }
446
- },
447
- "post": {
448
- "operationId": "addSharedInbox",
449
- "summary": "addSharedInbox",
450
- "description": "Creates a new shared inbox for the organization.\n\nShared inboxes help teams organize and categorize incoming emails.\nEach inbox requires a name and color for visual identification.\n",
451
- "tags": [
452
- "Shared inboxes"
453
- ],
454
- "requestBody": {
455
- "description": "The shared inbox configuration to create",
456
- "required": true,
457
- "content": {
458
- "application/json": {
459
- "schema": {
460
- "$ref": "#/components/schemas/CreateSharedInboxPayload"
461
- },
462
- "example": {
463
- "name": "Sales Inquiries",
464
- "color": "#2196F3",
465
- "description": "Inbound sales and pricing requests",
466
- "assignees": [
467
- "user-123",
468
- "user-456"
469
- ]
470
- }
471
- }
472
- }
473
- },
474
- "responses": {
475
- "201": {
476
- "$ref": "#/components/responses/CreateSharedInboxSuccessResponse"
477
- },
478
- "400": {
479
- "$ref": "#/components/responses/BadRequest"
480
- },
481
- "403": {
482
- "$ref": "#/components/responses/Forbidden"
483
- },
484
- "409": {
485
- "$ref": "#/components/responses/Conflict"
486
- },
487
- "500": {
488
- "$ref": "#/components/responses/InternalServerError"
489
- }
490
- }
491
- }
492
- },
493
- "/v2/email-settings/inbox-buckets": {
494
- "get": {
495
- "operationId": "listInboxBuckets",
496
- "summary": "listInboxBuckets",
497
- "description": "Retrieves all inbox buckets for the organization.\n\nInbox buckets are internal storage containers that correspond to shared inboxes.\nEach shared inbox has an associated bucket for storing messages.\n\n**Note**: The default bucket (with ID `default`) is not included in this list but\nis always available for all organizations.\n",
498
- "tags": [
499
- "Inbox buckets"
500
- ],
501
- "responses": {
502
- "200": {
503
- "$ref": "#/components/responses/ListInboxBucketsSuccessResponse"
504
- },
505
- "403": {
506
- "$ref": "#/components/responses/Forbidden"
507
- },
508
- "500": {
509
- "$ref": "#/components/responses/InternalServerError"
510
- }
511
- }
512
- }
513
- },
514
- "/v2/outlook/connect": {
515
- "get": {
516
- "operationId": "connectOutlook",
517
- "summary": "connectOutlook",
518
- "description": "Returns Microsoft authorization URL for Outlook OAuth.",
519
- "tags": [
520
- "O365 Outlook Connection"
521
- ],
522
- "responses": {
523
- "200": {
524
- "description": "Authorization URL",
525
- "content": {
526
- "application/json": {
527
- "schema": {
528
- "type": "object",
529
- "properties": {
530
- "authorization_url": {
531
- "type": "string"
532
- }
533
- }
534
- }
535
- }
536
- }
537
- },
538
- "403": {
539
- "$ref": "#/components/responses/OutlookErrorResponse"
540
- }
541
- }
542
- }
543
- },
544
- "/v2/outlook/connection/status": {
545
- "get": {
546
- "operationId": "getOutlookConnectionStatus",
547
- "summary": "getOutlookConnectionStatus",
548
- "description": "Returns all Microsoft 365 / Outlook connections for the organization.\nSupports multiple connections (one per Azure AD tenant).\n\nEach connection includes an `action` field that tells the UI what button to show\nand what endpoint to call. All actions use GET /outlook/connect.\n",
549
- "tags": [
550
- "O365 Outlook Connection"
551
- ],
552
- "responses": {
553
- "200": {
554
- "description": "Connection status retrieved successfully",
555
- "content": {
556
- "application/json": {
557
- "schema": {
558
- "type": "object",
559
- "required": [
560
- "connections",
561
- "has_connections"
562
- ],
563
- "properties": {
564
- "connections": {
565
- "type": "array",
566
- "description": "List of Outlook connections (one per tenant)",
567
- "items": {
568
- "$ref": "#/components/schemas/OutlookConnectionStatus"
569
- }
570
- },
571
- "has_connections": {
572
- "type": "boolean",
573
- "description": "Whether any connections exist"
574
- }
575
- }
576
- }
577
- }
578
- }
579
- },
580
- "400": {
581
- "description": "Bad request - missing organization ID"
582
- },
583
- "500": {
584
- "description": "Internal server error"
585
- }
586
- }
587
- }
588
- },
589
- "/v2/outlook/connection/disconnect": {
590
- "post": {
591
- "operationId": "disconnectOutlook",
592
- "summary": "disconnectOutlook",
593
- "description": "Removes the Microsoft 365 / Outlook connection for a specific tenant.\nThis deletes the stored tokens and disconnects the integration.\n",
594
- "tags": [
595
- "O365 Outlook Connection"
596
- ],
597
- "requestBody": {
598
- "required": true,
599
- "content": {
600
- "application/json": {
601
- "schema": {
602
- "type": "object",
603
- "required": [
604
- "tenant_id"
605
- ],
606
- "properties": {
607
- "tenant_id": {
608
- "type": "string",
609
- "description": "Azure AD Tenant ID of the connection to disconnect"
610
- }
611
- }
612
- }
613
- }
614
- }
615
- },
616
- "responses": {
617
- "200": {
618
- "description": "Successfully disconnected",
619
- "content": {
620
- "application/json": {
621
- "schema": {
622
- "type": "object",
623
- "properties": {
624
- "success": {
625
- "type": "boolean"
626
- },
627
- "tenant_id": {
628
- "type": "string",
629
- "description": "The tenant ID that was disconnected"
630
- },
631
- "affected_shared_inboxes": {
632
- "type": "array",
633
- "items": {
634
- "type": "string"
635
- },
636
- "description": "List of shared inbox IDs that were affected by the disconnection"
637
- }
638
- }
639
- }
640
- }
641
- }
642
- },
643
- "400": {
644
- "description": "Bad request - missing tenant_id or organization ID"
645
- },
646
- "404": {
647
- "description": "Connection not found"
648
- },
649
- "500": {
650
- "description": "Internal server error"
651
- }
652
- }
653
- }
654
- },
655
- "/v2/outlook/mailbox/connect": {
656
- "post": {
657
- "operationId": "connectOutlookMailbox",
658
- "summary": "connectOutlookMailbox",
659
- "description": "Connects an Outlook mailbox:\n 1. Validates the user has access to the mailbox via Microsoft Graph API\n 2. Creates a mapping between the email address of the mailbox and the outlook connection\n 3. Enables the user to send emails as the mailbox's email address\n",
660
- "tags": [
661
- "O365 Outlook Connection"
662
- ],
663
- "requestBody": {
664
- "required": true,
665
- "content": {
666
- "application/json": {
667
- "schema": {
668
- "type": "object",
669
- "required": [
670
- "email"
671
- ],
672
- "properties": {
673
- "email": {
674
- "type": "string",
675
- "format": "email",
676
- "description": "Email address of the Outlook mailbox to connect"
677
- },
678
- "shared_inbox_id": {
679
- "type": "string",
680
- "description": "Shared inbox ID to associate with the mailbox. Defaults to the default shared inbox.",
681
- "default": "default"
682
- },
683
- "mailboxSyncTimeframe": {
684
- "type": "string",
685
- "enum": [
686
- "5m",
687
- "1w",
688
- "2w",
689
- "1m"
690
- ],
691
- "description": "Optional timeframe for initial mailbox sync. When provided, triggers an automatic\nmailbox sync after connecting the mailbox, syncing emails from the specified period.\n"
692
- }
693
- }
694
- }
695
- }
696
- }
697
- },
698
- "responses": {
699
- "201": {
700
- "description": "Mailbox connected successfully",
701
- "content": {
702
- "application/json": {
703
- "schema": {
704
- "type": "object",
705
- "required": [
706
- "email_address",
707
- "outlook_email",
708
- "tenant_id",
709
- "provider"
710
- ],
711
- "properties": {
712
- "email_address": {
713
- "$ref": "#/components/schemas/EmailAddressResponse"
714
- },
715
- "outlook_email": {
716
- "type": "string",
717
- "format": "email",
718
- "description": "The email of the connected mailbox"
719
- },
720
- "tenant_id": {
721
- "type": "string",
722
- "description": "Azure AD Tenant ID that provisions this mailbox"
723
- },
724
- "provider": {
725
- "type": "string",
726
- "enum": [
727
- "outlook"
728
- ],
729
- "description": "The provider type"
730
- }
731
- }
732
- }
733
- }
734
- }
735
- },
736
- "400": {
737
- "description": "Bad request - missing email parameter"
738
- },
739
- "401": {
740
- "description": "Not connected to Microsoft 365"
741
- },
742
- "403": {
743
- "description": "Access denied - user does not have access to the mailbox"
744
- },
745
- "409": {
746
- "description": "A mailbox email already connected to an Outlook connection"
747
- },
748
- "500": {
749
- "description": "Internal server error"
750
- }
751
- }
752
- }
753
- },
754
- "/v2/outlook/mailbox/{email}/disconnect": {
755
- "post": {
756
- "operationId": "disconnectOutlookMailbox",
757
- "summary": "Disconnect Outlook Mailbox",
758
- "description": "Disconnects a single Outlook mailbox by email address.\nDeletes the email address entity, Outlook email mapping, and Graph API subscriptions.\nDoes not affect the tenant-level Outlook connection.\n",
759
- "tags": [
760
- "O365 Outlook Connection"
761
- ],
762
- "parameters": [
763
- {
764
- "name": "email",
765
- "in": "path",
766
- "required": true,
767
- "schema": {
768
- "type": "string",
769
- "format": "email"
770
- },
771
- "description": "Email address of the Outlook mailbox to disconnect"
772
- }
773
- ],
774
- "responses": {
775
- "200": {
776
- "description": "Mailbox disconnected successfully",
777
- "content": {
778
- "application/json": {
779
- "schema": {
780
- "type": "object",
781
- "required": [
782
- "success",
783
- "email"
784
- ],
785
- "properties": {
786
- "success": {
787
- "type": "boolean"
788
- },
789
- "email": {
790
- "type": "string",
791
- "format": "email",
792
- "description": "The email address that was disconnected"
793
- }
794
- }
795
- }
796
- }
797
- }
798
- },
799
- "404": {
800
- "description": "No Outlook mapping found for this email address"
801
- },
802
- "500": {
803
- "description": "Internal server error"
804
- }
805
- }
806
- }
807
- },
808
- "/v2/outlook/mailbox/{email}/sync": {
809
- "post": {
810
- "operationId": "startMailboxSync",
811
- "summary": "Start Mailbox Sync",
812
- "description": "Triggers an Outlook mailbox sync for the specified email address.\nSyncs existing emails (inbox + sent items) for the specified timeframe.\n",
813
- "tags": [
814
- "O365 Outlook Connection"
815
- ],
816
- "parameters": [
817
- {
818
- "name": "email",
819
- "in": "path",
820
- "required": true,
821
- "schema": {
822
- "type": "string",
823
- "format": "email"
824
- },
825
- "description": "Email address of the Outlook mailbox to sync"
826
- }
827
- ],
828
- "requestBody": {
829
- "required": true,
830
- "content": {
831
- "application/json": {
832
- "schema": {
833
- "type": "object",
834
- "required": [
835
- "timeframe"
836
- ],
837
- "properties": {
838
- "timeframe": {
839
- "$ref": "#/components/schemas/MailboxSyncTimeframePeriods",
840
- "description": "Sync period:\n- 5m: last 5 minutes (quick sync)\n- 1w: 1 week\n- 2w: 2 weeks\n- 1m: 1 month\n"
841
- }
842
- }
843
- }
844
- }
845
- }
846
- },
847
- "responses": {
848
- "202": {
849
- "description": "Sync started successfully",
850
- "content": {
851
- "application/json": {
852
- "schema": {
853
- "type": "object",
854
- "required": [
855
- "execution_id",
856
- "status",
857
- "timeframe"
858
- ],
859
- "properties": {
860
- "execution_id": {
861
- "type": "string",
862
- "description": "The execution ID"
863
- },
864
- "status": {
865
- "$ref": "#/components/schemas/MailboxSyncStatuses"
866
- },
867
- "timeframe": {
868
- "$ref": "#/components/schemas/MailboxSyncTimeframePeriods"
869
- }
870
- }
871
- }
872
- }
873
- }
874
- },
875
- "400": {
876
- "description": "Invalid input provided"
877
- },
878
- "404": {
879
- "description": "Mailbox not connected for the provided email address"
880
- },
881
- "409": {
882
- "description": "A sync in progress for the provided mailbox"
883
- },
884
- "500": {
885
- "description": "Internal server error"
886
- }
887
- }
888
- }
889
- },
890
- "/v2/outlook/mailbox/{email}/sync/status": {
891
- "get": {
892
- "operationId": "getMailboxSyncStatus",
893
- "summary": "Get Mailbox Sync Status",
894
- "description": "Returns the current or latest sync status for the specified mailbox.\nPoll this endpoint to track sync progress.\n",
895
- "tags": [
896
- "O365 Outlook Connection"
897
- ],
898
- "parameters": [
899
- {
900
- "name": "email",
901
- "in": "path",
902
- "required": true,
903
- "schema": {
904
- "type": "string",
905
- "format": "email"
906
- },
907
- "description": "Email address of the Outlook mailbox"
908
- }
909
- ],
910
- "responses": {
911
- "200": {
912
- "description": "Sync status retrieved",
913
- "content": {
914
- "application/json": {
915
- "schema": {
916
- "$ref": "#/components/schemas/MailboxSyncStatus"
917
- }
918
- }
919
- }
920
- },
921
- "404": {
922
- "description": "No sync found for this mailbox"
923
- },
924
- "500": {
925
- "description": "Internal server error"
926
- }
927
- }
928
- }
929
- },
930
- "/v2/outlook/mailbox/{email}/sync/retry": {
931
- "post": {
932
- "operationId": "retryMailboxSync",
933
- "summary": "Retry Failed Messages",
934
- "description": "Retries failed messages from a previous sync execution.\nOnly retries messages with status FAILED (not PERMANENTLY_FAILED).\nMessages that fail 3+ retries become PERMANENTLY_FAILED.\n",
935
- "tags": [
936
- "O365 Outlook Connection"
937
- ],
938
- "parameters": [
939
- {
940
- "name": "email",
941
- "in": "path",
942
- "required": true,
943
- "schema": {
944
- "type": "string",
945
- "format": "email"
946
- },
947
- "description": "Email address of the Outlook mailbox"
948
- }
949
- ],
950
- "requestBody": {
951
- "required": true,
952
- "content": {
953
- "application/json": {
954
- "schema": {
955
- "type": "object",
956
- "required": [
957
- "sync_id"
958
- ],
959
- "properties": {
960
- "sync_id": {
961
- "type": "string",
962
- "description": "Execution ID of the sync to retry"
963
- },
964
- "scope": {
965
- "type": "string",
966
- "enum": [
967
- "all_failed"
968
- ],
969
- "description": "Retry scope. Use 'all_failed' to retry all retryable failed messages."
970
- },
971
- "message_ids": {
972
- "type": "array",
973
- "items": {
974
- "type": "string"
975
- },
976
- "description": "Specific Graph message IDs to retry (alternative to scope)"
977
- }
978
- }
979
- }
980
- }
981
- }
982
- },
983
- "responses": {
984
- "202": {
985
- "description": "Retry started",
986
- "content": {
987
- "application/json": {
988
- "schema": {
989
- "type": "object",
990
- "required": [
991
- "retry_execution_id",
992
- "messages_queued"
993
- ],
994
- "properties": {
995
- "retry_execution_id": {
996
- "type": "string",
997
- "description": "Execution ID for the retry sync"
998
- },
999
- "messages_queued": {
1000
- "type": "integer",
1001
- "description": "Number of messages queued for retry"
1002
- }
1003
- }
1004
- }
1005
- }
1006
- }
1007
- },
1008
- "404": {
1009
- "description": "No sync found or no retryable messages"
1010
- },
1011
- "409": {
1012
- "description": "A sync is already running for this mailbox"
1013
- },
1014
- "500": {
1015
- "description": "Internal server error"
1016
- }
1017
- }
1018
- }
1019
- },
1020
- "/v2/outlook/mailbox/mappings": {
1021
- "get": {
1022
- "operationId": "getConnectedOutlookEmails",
1023
- "summary": "getConnectedOutlookEmails",
1024
- "description": "Returns all Outlook email addresses connected to the organization.\n",
1025
- "tags": [
1026
- "O365 Outlook Connection"
1027
- ],
1028
- "responses": {
1029
- "200": {
1030
- "description": "Outlook emails retrieved successfully",
1031
- "content": {
1032
- "application/json": {
1033
- "schema": {
1034
- "type": "object",
1035
- "required": [
1036
- "outlook_emails",
1037
- "count"
1038
- ],
1039
- "properties": {
1040
- "outlook_emails": {
1041
- "type": "array",
1042
- "items": {
1043
- "$ref": "#/components/schemas/ConnectedOutlookEmail"
1044
- }
1045
- },
1046
- "count": {
1047
- "type": "integer",
1048
- "description": "Number of Outlook emails"
1049
- }
1050
- }
1051
- }
1052
- }
1053
- }
1054
- },
1055
- "400": {
1056
- "description": "Bad request - missing organization ID"
1057
- },
1058
- "500": {
1059
- "description": "Internal server error"
1060
- }
1061
- }
1062
- }
1063
- },
1064
- "/v2/outlook/oauth/callback": {
1065
- "get": {
1066
- "operationId": "outlookOAuthCallback",
1067
- "summary": "outlookOAuthCallback",
1068
- "description": "Exchanges authorization code for tokens and stores them.",
1069
- "tags": [
1070
- "O365 Outlook Connection"
1071
- ],
1072
- "security": [],
1073
- "parameters": [
1074
- {
1075
- "name": "code",
1076
- "in": "query",
1077
- "required": false,
1078
- "schema": {
1079
- "type": "string"
1080
- }
1081
- },
1082
- {
1083
- "name": "state",
1084
- "in": "query",
1085
- "required": true,
1086
- "schema": {
1087
- "type": "string"
1088
- }
1089
- },
1090
- {
1091
- "name": "session_state",
1092
- "in": "query",
1093
- "required": false,
1094
- "schema": {
1095
- "type": "string"
1096
- }
1097
- },
1098
- {
1099
- "name": "error",
1100
- "in": "query",
1101
- "required": false,
1102
- "schema": {
1103
- "type": "string"
1104
- }
1105
- },
1106
- {
1107
- "name": "error_description",
1108
- "in": "query",
1109
- "required": false,
1110
- "schema": {
1111
- "type": "string"
1112
- }
1113
- },
1114
- {
1115
- "name": "error_subcode",
1116
- "in": "query",
1117
- "required": false,
1118
- "schema": {
1119
- "type": "string"
1120
- }
1121
- },
1122
- {
1123
- "name": "client_info",
1124
- "in": "query",
1125
- "required": false,
1126
- "schema": {
1127
- "type": "string"
1128
- }
1129
- },
1130
- {
1131
- "name": "error_uri",
1132
- "in": "query",
1133
- "required": false,
1134
- "schema": {
1135
- "type": "string"
1136
- }
1137
- },
1138
- {
1139
- "name": "admin_consent",
1140
- "in": "query",
1141
- "required": false,
1142
- "schema": {
1143
- "type": "string"
1144
- }
1145
- },
1146
- {
1147
- "name": "tenant",
1148
- "in": "query",
1149
- "required": false,
1150
- "schema": {
1151
- "type": "string"
1152
- }
1153
- }
1154
- ],
1155
- "responses": {
1156
- "200": {
1157
- "description": "Stored",
1158
- "content": {
1159
- "application/json": {
1160
- "schema": {
1161
- "type": "object",
1162
- "properties": {
1163
- "connected": {
1164
- "type": "boolean"
1165
- },
1166
- "expires_at": {
1167
- "type": "string",
1168
- "format": "date-time"
1169
- },
1170
- "scope": {
1171
- "type": "string"
1172
- }
1173
- }
1174
- }
1175
- }
1176
- }
1177
- }
1178
- }
1179
- }
1180
- },
1181
- "/v1/email-settings": {
1182
- "get": {
1183
- "operationId": "getSettings",
1184
- "summary": "getSettings",
1185
- "description": "Retrieves settings of a specific type for the organization.\n\nIf an `id` is provided, returns only that specific setting.\nOtherwise, returns all settings of the specified type.\n\n## Setting Types\n\n| Type | Description |\n|------|-------------|\n| `signature` | HTML email signatures |\n| `email_domain` | Custom email domains |\n| `email_address` | Sender email addresses |\n| `whitelist_email_address` | Addresses exempt from duplicate detection |\n| `restrict_duplicates_within` | Time window for duplicate email detection |\n",
1186
- "tags": [
1187
- "Settings"
1188
- ],
1189
- "parameters": [
1190
- {
1191
- "name": "type",
1192
- "description": "The type of settings to retrieve. Determines which category of\nemail settings will be returned.\n",
1193
- "in": "query",
1194
- "required": true,
1195
- "schema": {
1196
- "$ref": "#/components/schemas/SettingType"
1197
- },
1198
- "example": "signature"
1199
- },
1200
- {
1201
- "name": "id",
1202
- "description": "Optional ID to retrieve a specific setting. If omitted, all settings\nof the specified type are returned.\n",
1203
- "in": "query",
1204
- "schema": {
1205
- "type": "string"
1206
- },
1207
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1208
- }
1209
- ],
1210
- "responses": {
1211
- "200": {
1212
- "description": "Successfully retrieved settings. Returns either a single setting object\n(when `id` is provided) or an array of settings.\n",
1213
- "content": {
1214
- "application/json": {
1215
- "schema": {
1216
- "$ref": "#/components/schemas/SettingsResponse"
1217
- },
1218
- "examples": {
1219
- "signature_list": {
1220
- "summary": "List of email signatures",
1221
- "value": [
1222
- {
1223
- "id": "sig-123",
1224
- "type": "signature",
1225
- "name": "Default Signature",
1226
- "value": "Best regards",
1227
- "html": "<p>Best regards,<br/>The Team</p>",
1228
- "created_at": "2024-01-15T10:30:00Z"
1229
- }
1230
- ]
1231
- },
1232
- "single_signature": {
1233
- "summary": "Single signature by ID",
1234
- "value": {
1235
- "id": "sig-123",
1236
- "type": "signature",
1237
- "name": "Default Signature",
1238
- "value": "Best regards",
1239
- "html": "<p>Best regards,<br/>The Team</p>",
1240
- "created_at": "2024-01-15T10:30:00Z"
1241
- }
1242
- }
1243
- }
1244
- }
1245
- }
1246
- },
1247
- "403": {
1248
- "$ref": "#/components/responses/Forbidden"
1249
- },
1250
- "404": {
1251
- "$ref": "#/components/responses/NotFound"
1252
- }
1253
- }
1254
- },
1255
- "post": {
1256
- "operationId": "addSetting",
1257
- "summary": "addSetting",
1258
- "description": "Creates a new setting of the specified type.\n\nThe setting type determines which fields are applicable:\n- **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)\n- **email_domain**: Requires `value` (domain name)\n- **whitelist_email_address**: Requires `value` (email address)\n- **restrict_duplicates_within**: Requires `value` (time duration like \"5m\", \"1d\")\n",
1259
- "tags": [
1260
- "Settings"
1261
- ],
1262
- "requestBody": {
1263
- "description": "The setting to create",
1264
- "required": true,
1265
- "content": {
1266
- "application/json": {
1267
- "schema": {
1268
- "$ref": "#/components/schemas/Setting"
1269
- },
1270
- "examples": {
1271
- "create_signature": {
1272
- "summary": "Create an email signature",
1273
- "value": {
1274
- "type": "signature",
1275
- "name": "Sales Signature",
1276
- "value": "Best regards, Sales Team",
1277
- "html": "<p>Best regards,<br/><strong>Sales Team</strong></p>"
1278
- }
1279
- },
1280
- "create_whitelist": {
1281
- "summary": "Whitelist an email address from duplicate detection",
1282
- "value": {
1283
- "type": "whitelist_email_address",
1284
- "value": "noreply@automated-system.com"
1285
- }
1286
- },
1287
- "set_duplicate_window": {
1288
- "summary": "Set duplicate detection time window",
1289
- "value": {
1290
- "type": "restrict_duplicates_within",
1291
- "value": "5m"
1292
- }
1293
- }
1294
- }
1295
- }
1296
- }
1297
- },
1298
- "responses": {
1299
- "200": {
1300
- "description": "Setting created successfully",
1301
- "content": {
1302
- "application/json": {
1303
- "schema": {
1304
- "$ref": "#/components/schemas/SettingsResponse"
1305
- }
1306
- }
1307
- }
1308
- },
1309
- "403": {
1310
- "$ref": "#/components/responses/Forbidden"
1311
- },
1312
- "404": {
1313
- "$ref": "#/components/responses/NotFound"
1314
- }
1315
- }
1316
- },
1317
- "delete": {
1318
- "operationId": "deleteSetting",
1319
- "summary": "deleteSetting",
1320
- "description": "Deletes a setting by its ID and type.\n\nBoth the `id` and `type` are required to uniquely identify the setting to delete.\n\n**Warning**: This action cannot be undone.\n",
1321
- "tags": [
1322
- "Settings"
1323
- ],
1324
- "requestBody": {
1325
- "description": "The setting identifier to delete",
1326
- "required": true,
1327
- "content": {
1328
- "application/json": {
1329
- "schema": {
1330
- "type": "object",
1331
- "required": [
1332
- "id",
1333
- "type"
1334
- ],
1335
- "properties": {
1336
- "type": {
1337
- "$ref": "#/components/schemas/SettingType"
1338
- },
1339
- "id": {
1340
- "type": "string",
1341
- "description": "The unique identifier of the setting to delete",
1342
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1343
- }
1344
- }
1345
- },
1346
- "example": {
1347
- "type": "signature",
1348
- "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1349
- }
1350
- }
1351
- }
1352
- },
1353
- "responses": {
1354
- "200": {
1355
- "description": "Setting deleted successfully. Returns the deleted setting.",
1356
- "content": {
1357
- "application/json": {
1358
- "schema": {
1359
- "$ref": "#/components/schemas/Setting"
1360
- }
1361
- }
1362
- }
1363
- },
1364
- "403": {
1365
- "$ref": "#/components/responses/Forbidden"
1366
- },
1367
- "404": {
1368
- "$ref": "#/components/responses/NotFound"
1369
- }
1370
- }
1371
- }
1372
- },
1373
- "/v1/email-settings/{id}": {
1374
- "post": {
1375
- "operationId": "updateSetting",
1376
- "summary": "updateSetting",
1377
- "description": "Updates an existing setting identified by its ID.\n\nInclude the `type` field in the request body to specify which setting type\nis being updated. Only the fields provided will be updated.\n",
1378
- "tags": [
1379
- "Settings"
1380
- ],
1381
- "parameters": [
1382
- {
1383
- "name": "id",
1384
- "description": "The unique identifier of the setting to update",
1385
- "in": "path",
1386
- "required": true,
1387
- "schema": {
1388
- "type": "string"
1389
- },
1390
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1391
- }
1392
- ],
1393
- "requestBody": {
1394
- "description": "The setting fields to update",
1395
- "required": true,
1396
- "content": {
1397
- "application/json": {
1398
- "schema": {
1399
- "$ref": "#/components/schemas/Setting"
1400
- },
1401
- "example": {
1402
- "type": "signature",
1403
- "name": "Updated Signature Name",
1404
- "html": "<p>Updated signature content</p>"
1405
- }
1406
- }
1407
- }
1408
- },
1409
- "responses": {
1410
- "200": {
1411
- "description": "Setting updated successfully. Returns the updated setting.",
1412
- "content": {
1413
- "application/json": {
1414
- "schema": {
1415
- "$ref": "#/components/schemas/Setting"
1416
- }
1417
- }
1418
- }
1419
- },
1420
- "403": {
1421
- "$ref": "#/components/responses/Forbidden"
1422
- },
1423
- "404": {
1424
- "$ref": "#/components/responses/NotFound"
1425
- }
1426
- }
1427
- }
1428
- },
1429
- "/v1/email-settings/domain": {
1430
- "post": {
1431
- "operationId": "addDomain",
1432
- "summary": "addDomain",
1433
- "description": "Adds a custom email domain to the organization.\n\nAfter adding the domain, you must:\n1. Configure the required DNS records (provided in the response)\n2. Verify the domain using the verification endpoint\n\nUntil verification is complete, the domain cannot be used for sending emails.\n",
1434
- "tags": [
1435
- "Domains"
1436
- ],
1437
- "requestBody": {
1438
- "description": "The domain to add",
1439
- "required": true,
1440
- "content": {
1441
- "application/json": {
1442
- "schema": {
1443
- "$ref": "#/components/schemas/Domain"
1444
- },
1445
- "example": {
1446
- "domain": "mail.yourcompany.com"
1447
- }
1448
- }
1449
- }
1450
- },
1451
- "responses": {
1452
- "200": {
1453
- "description": "Domain added successfully. The response includes DNS records that must be\nconfigured before verification.\n",
1454
- "content": {
1455
- "application/json": {
1456
- "schema": {
1457
- "$ref": "#/components/schemas/SettingsResponse"
1458
- }
1459
- }
1460
- }
1461
- },
1462
- "403": {
1463
- "$ref": "#/components/responses/Forbidden"
1464
- },
1465
- "404": {
1466
- "$ref": "#/components/responses/NotFound"
1467
- }
1468
- }
1469
- },
1470
- "delete": {
1471
- "operationId": "deleteDomain",
1472
- "summary": "deleteDomain",
1473
- "description": "Removes a custom email domain from the organization.\n\n**Warning**: Deleting a domain will prevent sending emails from any addresses\nusing this domain. Existing email addresses on this domain should be removed\nor reassigned before deleting the domain.\n",
1474
- "tags": [
1475
- "Domains"
1476
- ],
1477
- "requestBody": {
1478
- "description": "The domain to delete",
1479
- "required": true,
1480
- "content": {
1481
- "application/json": {
1482
- "schema": {
1483
- "$ref": "#/components/schemas/Domain"
1484
- },
1485
- "example": {
1486
- "domain": "mail.yourcompany.com"
1487
- }
1488
- }
1489
- }
1490
- },
1491
- "responses": {
1492
- "204": {
1493
- "description": "Domain deleted successfully"
1494
- },
1495
- "403": {
1496
- "$ref": "#/components/responses/Forbidden"
1497
- },
1498
- "404": {
1499
- "$ref": "#/components/responses/NotFound"
1500
- }
1501
- }
1502
- }
1503
- },
1504
- "/v1/email-settings/domain/name-servers:verify": {
1505
- "post": {
1506
- "operationId": "verifyNameServers",
1507
- "summary": "verifyNameServers",
1508
- "description": "Verifies that the domain's name server (NS) records are correctly configured.\n\nThis check ensures that DNS resolution is properly set up for the domain\nbefore proceeding with full domain verification.\n\nRun this verification after configuring NS records in your DNS provider.\n",
1509
- "tags": [
1510
- "Domains"
1511
- ],
1512
- "requestBody": {
1513
- "description": "The domain to verify name servers for",
1514
- "required": true,
1515
- "content": {
1516
- "application/json": {
1517
- "schema": {
1518
- "$ref": "#/components/schemas/Domain"
1519
- },
1520
- "example": {
1521
- "domain": "mail.yourcompany.com"
1522
- }
1523
- }
1524
- }
1525
- },
1526
- "responses": {
1527
- "200": {
1528
- "description": "Name server verification result. Check the response to see if\nverification passed or if additional DNS configuration is needed.\n",
1529
- "content": {
1530
- "application/json": {
1531
- "schema": {
1532
- "$ref": "#/components/schemas/SettingsResponse"
1533
- }
1534
- }
1535
- }
1536
- },
1537
- "403": {
1538
- "$ref": "#/components/responses/Forbidden"
1539
- },
1540
- "404": {
1541
- "$ref": "#/components/responses/NotFound"
1542
- }
1543
- }
1544
- }
1545
- },
1546
- "/v1/email-settings/domain:verify": {
1547
- "post": {
1548
- "operationId": "verifyDomain",
1549
- "summary": "verifyDomain",
1550
- "description": "Verifies ownership and configuration of a custom email domain.\n\nDomain verification checks:\n- DNS TXT records for domain ownership\n- MX records for email routing\n- SPF records for sender authentication\n- DKIM records for email signing\n\nOnce verified, the domain can be used to create email addresses and send emails.\n",
1551
- "tags": [
1552
- "Domains"
1553
- ],
1554
- "requestBody": {
1555
- "description": "The domain to verify",
1556
- "required": true,
1557
- "content": {
1558
- "application/json": {
1559
- "schema": {
1560
- "$ref": "#/components/schemas/Domain"
1561
- },
1562
- "example": {
1563
- "domain": "mail.yourcompany.com"
1564
- }
1565
- }
1566
- }
1567
- },
1568
- "responses": {
1569
- "200": {
1570
- "description": "Domain verification result. The response indicates whether verification\npassed and which DNS records (if any) still need configuration.\n",
1571
- "content": {
1572
- "application/json": {
1573
- "schema": {
1574
- "$ref": "#/components/schemas/SettingsResponse"
1575
- }
1576
- }
1577
- }
1578
- },
1579
- "403": {
1580
- "$ref": "#/components/responses/Forbidden"
1581
- },
1582
- "404": {
1583
- "$ref": "#/components/responses/NotFound"
1584
- }
1585
- }
1586
- }
1587
- }
1588
- },
1589
- "components": {
1590
- "responses": {
1591
- "ListInboxBucketsSuccessResponse": {
1592
- "description": "Success",
1593
- "content": {
1594
- "application/json": {
1595
- "schema": {
1596
- "type": "array",
1597
- "items": {
1598
- "$ref": "#/components/schemas/InboxBucketResponse"
1599
- }
1600
- }
1601
- }
1602
- }
1603
- },
1604
- "ProvisionEpilotEmailAddressSuccessResponse": {
1605
- "description": "Success",
1606
- "content": {
1607
- "application/json": {
1608
- "schema": {
1609
- "$ref": "#/components/schemas/EmailAddressResponse"
1610
- }
1611
- }
1612
- }
1613
- },
1614
- "SetEmailAddressPrimarySuccessResponse": {
1615
- "description": "Success",
1616
- "content": {
1617
- "application/json": {
1618
- "schema": {
1619
- "$ref": "#/components/schemas/EmailAddressResponse"
1620
- }
1621
- }
1622
- }
1623
- },
1624
- "CreateEmailAddressSuccessResponse": {
1625
- "description": "Success",
1626
- "content": {
1627
- "application/json": {
1628
- "schema": {
1629
- "$ref": "#/components/schemas/EmailAddressResponse"
1630
- }
1631
- }
1632
- }
1633
- },
1634
- "UpdateEmailAddressSuccessResponse": {
1635
- "description": "Success",
1636
- "content": {
1637
- "application/json": {
1638
- "schema": {
1639
- "$ref": "#/components/schemas/EmailAddressResponse"
1640
- }
1641
- }
1642
- }
1643
- },
1644
- "GetEmailAddressSuccessResponse": {
1645
- "description": "Success",
1646
- "content": {
1647
- "application/json": {
1648
- "schema": {
1649
- "$ref": "#/components/schemas/EmailAddressResponse"
1650
- }
1651
- }
1652
- }
1653
- },
1654
- "ListEmailAddressesSuccessResponse": {
1655
- "description": "Success",
1656
- "content": {
1657
- "application/json": {
1658
- "schema": {
1659
- "type": "array",
1660
- "items": {
1661
- "$ref": "#/components/schemas/EmailAddressResponse"
1662
- }
1663
- }
1664
- }
1665
- }
1666
- },
1667
- "NoContent": {
1668
- "description": "Success"
1669
- },
1670
- "CreateSharedInboxSuccessResponse": {
1671
- "description": "Success",
1672
- "content": {
1673
- "application/json": {
1674
- "schema": {
1675
- "$ref": "#/components/schemas/SharedInboxResponse"
1676
- }
1677
- }
1678
- }
1679
- },
1680
- "UpdateSharedInboxSuccessResponse": {
1681
- "description": "Success",
1682
- "content": {
1683
- "application/json": {
1684
- "schema": {
1685
- "$ref": "#/components/schemas/SharedInboxResponse"
1686
- }
1687
- }
1688
- }
1689
- },
1690
- "GetSharedInboxSuccessResponse": {
1691
- "description": "Success",
1692
- "content": {
1693
- "application/json": {
1694
- "schema": {
1695
- "$ref": "#/components/schemas/SharedInboxResponse"
1696
- }
1697
- }
1698
- }
1699
- },
1700
- "ListSharedInboxesSuccessResponse": {
1701
- "description": "Success",
1702
- "content": {
1703
- "application/json": {
1704
- "schema": {
1705
- "type": "array",
1706
- "items": {
1707
- "$ref": "#/components/schemas/SharedInboxResponse"
1708
- }
1709
- }
1710
- }
1711
- }
1712
- },
1713
- "BadRequest": {
1714
- "description": "The request was malformed or contains invalid data.\nCheck the error message for details on which fields are invalid.\n",
1715
- "content": {
1716
- "application/json": {
1717
- "schema": {
1718
- "$ref": "#/components/schemas/ErrorResponse"
1719
- },
1720
- "example": {
1721
- "error": "Invalid email address format",
1722
- "status": 400
1723
- }
1724
- }
1725
- }
1726
- },
1727
- "Forbidden": {
1728
- "description": "Access denied. The authenticated user does not have permission to perform\nthis operation. This may occur if:\n- The user lacks the required role or permissions\n- The resource belongs to a different organization\n",
1729
- "content": {
1730
- "application/json": {
1731
- "schema": {
1732
- "$ref": "#/components/schemas/ErrorResponse"
1733
- },
1734
- "example": {
1735
- "error": "Insufficient permissions to access this resource",
1736
- "status": 403
1737
- }
1738
- }
1739
- }
1740
- },
1741
- "NotFound": {
1742
- "description": "The requested resource was not found. Verify that:\n- The resource ID is correct\n- The resource exists in your organization\n- The resource has not been deleted\n",
1743
- "content": {
1744
- "application/json": {
1745
- "schema": {
1746
- "$ref": "#/components/schemas/ErrorResponse"
1747
- },
1748
- "example": {
1749
- "error": "Email address not found",
1750
- "status": 404
1751
- }
1752
- }
1753
- }
1754
- },
1755
- "Conflict": {
1756
- "description": "The request conflicts with the current state of the resource.\nCommon causes include:\n- Attempting to create a resource that already exists\n- Concurrent modification conflicts\n- Business rule violations (e.g., duplicate email address)\n",
1757
- "content": {
1758
- "application/json": {
1759
- "schema": {
1760
- "$ref": "#/components/schemas/ErrorResponse"
1761
- },
1762
- "example": {
1763
- "error": "Email address already exists in another configuration",
1764
- "status": 409
1765
- }
1766
- }
1767
- }
1768
- },
1769
- "InternalServerError": {
1770
- "description": "An unexpected error occurred on the server. If this error persists,\nplease contact support with the request details and timestamp.\n",
1771
- "content": {
1772
- "application/json": {
1773
- "schema": {
1774
- "$ref": "#/components/schemas/ErrorResponse"
1775
- },
1776
- "example": {
1777
- "error": "An unexpected error occurred",
1778
- "status": 500
1779
- }
1780
- }
1781
- }
1782
- },
1783
- "OutlookErrorResponse": {
1784
- "description": "An error response from the Outlook OAuth flow.\nMay include an admin consent URL if admin permissions are required.\n",
1785
- "content": {
1786
- "application/json": {
1787
- "schema": {
1788
- "$ref": "#/components/schemas/OutlookConnectionError"
1789
- },
1790
- "example": {
1791
- "error": "access_denied",
1792
- "error_description": "Access denied",
1793
- "admin_consent_url": "https://login.microsoftonline.com/common/adminconsent?client_id=..."
1794
- }
1795
- }
1796
- }
1797
- }
1798
- },
1799
- "parameters": {
1800
- "EmailAddressId": {
1801
- "name": "id",
1802
- "description": "Unique identifier of the email address. This can be either the UUID assigned\nwhen the email address was created, or the email address string itself.\n",
1803
- "in": "path",
1804
- "required": true,
1805
- "schema": {
1806
- "type": "string"
1807
- },
1808
- "examples": {
1809
- "uuid": {
1810
- "summary": "UUID identifier",
1811
- "value": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1812
- },
1813
- "email": {
1814
- "summary": "Email address string",
1815
- "value": "sales@yourcompany.com"
1816
- }
1817
- }
1818
- },
1819
- "SharedInboxId": {
1820
- "name": "id",
1821
- "description": "Unique identifier (UUID) of the shared inbox.\nUse `default` to reference the organization's default inbox.\n",
1822
- "in": "path",
1823
- "required": true,
1824
- "schema": {
1825
- "type": "string"
1826
- },
1827
- "examples": {
1828
- "uuid": {
1829
- "summary": "UUID identifier",
1830
- "value": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
1831
- },
1832
- "default": {
1833
- "summary": "Default inbox",
1834
- "value": "default"
1835
- }
1836
- }
1837
- }
1838
- },
1839
- "securitySchemes": {
1840
- "EpilotAuth": {
1841
- "type": "http",
1842
- "scheme": "bearer",
1843
- "description": "Primary authentication using epilot OAuth2 bearer token.\nInclude the JWT token in the Authorization header: `Authorization: Bearer <token>`\n",
1844
- "bearerFormat": "JWT"
1845
- },
1846
- "AsOrganization": {
1847
- "type": "apiKey",
1848
- "in": "header",
1849
- "name": "x-ivy-org-id",
1850
- "description": "**Internal use only.** Sets the organization context when using internal service-to-service\nauthentication. Not intended for external API consumers.\n"
1851
- },
1852
- "EpilotOrg": {
1853
- "type": "apiKey",
1854
- "name": "x-epilot-org-id",
1855
- "in": "header",
1856
- "description": "Overrides the target organization for shared tenant access.\nUse this header when you have access to multiple organizations and need to\nspecify which organization's data to access.\n"
1857
- }
1858
- },
1859
- "schemas": {
1860
- "MailboxSyncStatus": {
1861
- "type": "object",
1862
- "required": [
1863
- "execution_id",
1864
- "status",
1865
- "timeframe",
1866
- "started_at"
1867
- ],
1868
- "properties": {
1869
- "execution_id": {
1870
- "type": "string"
1871
- },
1872
- "status": {
1873
- "$ref": "#/components/schemas/MailboxSyncStatuses"
1874
- },
1875
- "timeframe": {
1876
- "$ref": "#/components/schemas/MailboxSyncTimeframePeriods"
1877
- },
1878
- "started_at": {
1879
- "type": "string",
1880
- "format": "date-time"
1881
- },
1882
- "completed_at": {
1883
- "type": "string",
1884
- "format": "date-time"
1885
- },
1886
- "inbox": {
1887
- "type": "object",
1888
- "properties": {
1889
- "status": {
1890
- "$ref": "#/components/schemas/MailboxSyncFolderStatuses"
1891
- },
1892
- "total_messages": {
1893
- "type": "integer"
1894
- },
1895
- "processed_messages": {
1896
- "type": "integer"
1897
- },
1898
- "failed_messages": {
1899
- "type": "integer"
1900
- }
1901
- }
1902
- },
1903
- "sent_items": {
1904
- "type": "object",
1905
- "properties": {
1906
- "status": {
1907
- "$ref": "#/components/schemas/MailboxSyncFolderStatuses"
1908
- },
1909
- "total_messages": {
1910
- "type": "integer"
1911
- },
1912
- "processed_messages": {
1913
- "type": "integer"
1914
- },
1915
- "failed_messages": {
1916
- "type": "integer"
1917
- }
1918
- }
1919
- }
1920
- }
1921
- },
1922
- "MailboxSyncStatuses": {
1923
- "type": "string",
1924
- "enum": [
1925
- "RUNNING",
1926
- "COMPLETED",
1927
- "COMPLETED_WITH_ERRORS",
1928
- "FAILED",
1929
- "CANCELLED"
1930
- ]
1931
- },
1932
- "MailboxSyncFolderStatuses": {
1933
- "type": "string",
1934
- "enum": [
1935
- "PENDING",
1936
- "RUNNING",
1937
- "COMPLETED",
1938
- "FAILED",
1939
- "SKIPPED"
1940
- ]
1941
- },
1942
- "MailboxSyncTimeframePeriods": {
1943
- "type": "string",
1944
- "enum": [
1945
- "5m",
1946
- "1w",
1947
- "2w",
1948
- "1m"
1949
- ]
1950
- },
1951
- "InboxBucketResponse": {
1952
- "type": "object",
1953
- "description": "Inbox bucket representing the storage container for a shared inbox.",
1954
- "required": [
1955
- "id",
1956
- "inbox_id"
1957
- ],
1958
- "properties": {
1959
- "id": {
1960
- "type": "string",
1961
- "description": "Unique identifier of the bucket",
1962
- "example": "bucket-abc"
1963
- },
1964
- "inbox_id": {
1965
- "type": "string",
1966
- "description": "ID of the shared inbox associated with this bucket",
1967
- "example": "inbox-xyz"
1968
- }
1969
- }
1970
- },
1971
- "ProvisionEpilotEmailAddressPayload": {
1972
- "type": "object",
1973
- "description": "Request payload for provisioning an epilot-managed email address.",
1974
- "required": [
1975
- "address"
1976
- ],
1977
- "properties": {
1978
- "address": {
1979
- "type": "string",
1980
- "description": "The epilot email address to provision (must be on @epilot.cloud domain)",
1981
- "example": "mycompany@epilot.cloud"
1982
- }
1983
- }
1984
- },
1985
- "SetEmailAddressPrimaryPayload": {
1986
- "type": "object",
1987
- "description": "Request payload for setting an email address as the organization's primary address.",
1988
- "required": [
1989
- "address"
1990
- ],
1991
- "properties": {
1992
- "address": {
1993
- "type": "string",
1994
- "description": "The email address to set as primary",
1995
- "example": "sales@yourcompany.com"
1996
- }
1997
- }
1998
- },
1999
- "UpdateEmailAddressPayload": {
2000
- "type": "object",
2001
- "description": "Request payload for updating an email address configuration.\nAll fields are optional; only provided fields will be updated.\n",
2002
- "properties": {
2003
- "name": {
2004
- "type": "string",
2005
- "description": "Display name shown as the sender name in emails",
2006
- "example": "Sales Team"
2007
- },
2008
- "user_ids": {
2009
- "type": "array",
2010
- "description": "List of user IDs who can send from this address",
2011
- "items": {
2012
- "type": "string"
2013
- },
2014
- "example": [
2015
- "user-123",
2016
- "user-456"
2017
- ]
2018
- },
2019
- "group_ids": {
2020
- "type": "array",
2021
- "description": "List of group IDs whose members can send from this address",
2022
- "items": {
2023
- "type": "string"
2024
- },
2025
- "example": [
2026
- "group-789"
2027
- ]
2028
- },
2029
- "default_signature_id": {
2030
- "type": "string",
2031
- "description": "ID of the signature to use by default when sending from this address",
2032
- "example": "sig-abc"
2033
- },
2034
- "shared_inbox_id": {
2035
- "type": "string",
2036
- "description": "ID of the shared inbox to associate with this address",
2037
- "example": "inbox-xyz"
2038
- },
2039
- "is_active": {
2040
- "type": "boolean",
2041
- "description": "Whether the email address is active and can be used for sending",
2042
- "example": true
2043
- }
2044
- }
2045
- },
2046
- "CreateEmailAddressPayload": {
2047
- "type": "object",
2048
- "description": "Request payload for creating a new email address.",
2049
- "required": [
2050
- "address"
2051
- ],
2052
- "properties": {
2053
- "address": {
2054
- "type": "string",
2055
- "description": "The email address to add (e.g., from a custom domain or external provider)",
2056
- "example": "support@yourcompany.com"
2057
- },
2058
- "name": {
2059
- "type": "string",
2060
- "description": "Display name shown as the sender name in emails",
2061
- "example": "Customer Support"
2062
- },
2063
- "user_ids": {
2064
- "type": "array",
2065
- "description": "List of user IDs who can send from this address",
2066
- "items": {
2067
- "type": "string"
2068
- },
2069
- "example": [
2070
- "user-123"
2071
- ]
2072
- },
2073
- "group_ids": {
2074
- "type": "array",
2075
- "description": "List of group IDs whose members can send from this address",
2076
- "items": {
2077
- "type": "string"
2078
- },
2079
- "example": [
2080
- "group-456"
2081
- ]
2082
- },
2083
- "default_signature_id": {
2084
- "type": "string",
2085
- "description": "ID of the signature to use by default when sending from this address",
2086
- "example": "sig-789"
2087
- },
2088
- "shared_inbox_id": {
2089
- "type": "string",
2090
- "description": "ID of the shared inbox to associate with this address",
2091
- "example": "inbox-abc"
2092
- }
2093
- }
2094
- },
2095
- "EmailAddressResponse": {
2096
- "description": "Email address configuration with all associated metadata.",
2097
- "allOf": [
2098
- {
2099
- "$ref": "#/components/schemas/SettingMeta"
2100
- },
2101
- {
2102
- "type": "object",
2103
- "required": [
2104
- "address"
2105
- ],
2106
- "properties": {
2107
- "address": {
2108
- "type": "string",
2109
- "description": "The email address string",
2110
- "example": "sales@yourcompany.com"
2111
- },
2112
- "name": {
2113
- "type": "string",
2114
- "description": "Display name shown as the sender name",
2115
- "example": "Sales Team"
2116
- },
2117
- "user_ids": {
2118
- "type": "array",
2119
- "description": "IDs of users who can send from this address",
2120
- "items": {
2121
- "type": "string"
2122
- },
2123
- "example": [
2124
- "user-123",
2125
- "user-456"
2126
- ]
2127
- },
2128
- "group_ids": {
2129
- "type": "array",
2130
- "description": "IDs of groups whose members can send from this address",
2131
- "items": {
2132
- "type": "string"
2133
- },
2134
- "example": [
2135
- "group-789"
2136
- ]
2137
- },
2138
- "default_signature_id": {
2139
- "type": "string",
2140
- "description": "ID of the default signature for this address",
2141
- "example": "sig-abc"
2142
- },
2143
- "shared_inbox_id": {
2144
- "type": "string",
2145
- "description": "ID of the associated shared inbox",
2146
- "example": "inbox-xyz"
2147
- },
2148
- "is_active": {
2149
- "type": "boolean",
2150
- "description": "Whether the address is currently active for sending",
2151
- "example": true
2152
- },
2153
- "is_primary": {
2154
- "type": "boolean",
2155
- "description": "Whether this is the organization's primary email address",
2156
- "example": false
2157
- },
2158
- "is_epilot_email_address": {
2159
- "type": "boolean",
2160
- "description": "Whether this is an epilot-managed address (@epilot.cloud)",
2161
- "example": false
2162
- }
2163
- }
2164
- }
2165
- ]
2166
- },
2167
- "ErrorResponse": {
2168
- "type": "object",
2169
- "description": "Standard error response format for all API errors.",
2170
- "required": [
2171
- "error",
2172
- "status"
2173
- ],
2174
- "properties": {
2175
- "error": {
2176
- "type": "string",
2177
- "description": "Human-readable error message describing what went wrong",
2178
- "example": "Resource not found"
2179
- },
2180
- "status": {
2181
- "type": "integer",
2182
- "description": "HTTP status code of the error",
2183
- "example": 404
2184
- }
2185
- }
2186
- },
2187
- "SettingMeta": {
2188
- "type": "object",
2189
- "description": "Common metadata fields for all settings and resources.",
2190
- "required": [
2191
- "id",
2192
- "created_at"
2193
- ],
2194
- "properties": {
2195
- "id": {
2196
- "type": "string",
2197
- "description": "Unique identifier (UUID) for the resource",
2198
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
2199
- },
2200
- "created_at": {
2201
- "type": "string",
2202
- "format": "date-time",
2203
- "description": "Timestamp when the resource was created",
2204
- "example": "2024-01-15T10:30:00Z"
2205
- },
2206
- "updated_at": {
2207
- "type": "string",
2208
- "format": "date-time",
2209
- "description": "Timestamp when the resource was last updated",
2210
- "example": "2024-01-20T14:45:00Z"
2211
- },
2212
- "created_by": {
2213
- "type": "string",
2214
- "description": "User ID of the user who created the resource",
2215
- "example": "user-123"
2216
- },
2217
- "updated_by": {
2218
- "type": "string",
2219
- "description": "User ID of the user who last updated the resource",
2220
- "example": "user-456"
2221
- }
2222
- }
2223
- },
2224
- "UpdateSharedInboxPayload": {
2225
- "type": "object",
2226
- "description": "Request payload for updating a shared inbox configuration.\nAll fields are optional; only provided fields will be updated.\n",
2227
- "properties": {
2228
- "color": {
2229
- "type": "string",
2230
- "description": "Hex color code for visual identification in the UI",
2231
- "example": "#4CAF50"
2232
- },
2233
- "name": {
2234
- "type": "string",
2235
- "description": "Display name of the shared inbox",
2236
- "example": "Customer Support"
2237
- },
2238
- "assignees": {
2239
- "type": "array",
2240
- "description": "List of user IDs assigned to this inbox",
2241
- "items": {
2242
- "type": "string"
2243
- },
2244
- "example": [
2245
- "user-123",
2246
- "user-456"
2247
- ]
2248
- },
2249
- "description": {
2250
- "type": "string",
2251
- "description": "Optional description of the inbox purpose",
2252
- "example": "Incoming customer support requests"
2253
- }
2254
- }
2255
- },
2256
- "CreateSharedInboxPayload": {
2257
- "type": "object",
2258
- "description": "Request payload for creating a new shared inbox.",
2259
- "required": [
2260
- "name",
2261
- "color"
2262
- ],
2263
- "properties": {
2264
- "id": {
2265
- "type": "string",
2266
- "description": "Optional custom ID for the inbox (auto-generated if not provided)",
2267
- "example": "support-inbox"
2268
- },
2269
- "color": {
2270
- "type": "string",
2271
- "description": "Hex color code for visual identification in the UI (required)",
2272
- "example": "#2196F3"
2273
- },
2274
- "name": {
2275
- "type": "string",
2276
- "description": "Display name of the shared inbox (required)",
2277
- "example": "Sales Inquiries"
2278
- },
2279
- "assignees": {
2280
- "type": "array",
2281
- "description": "List of user IDs to assign to this inbox",
2282
- "default": [],
2283
- "items": {
2284
- "type": "string"
2285
- },
2286
- "example": [
2287
- "user-123",
2288
- "user-456"
2289
- ]
2290
- },
2291
- "description": {
2292
- "type": "string",
2293
- "description": "Optional description of the inbox purpose",
2294
- "example": "Inbound sales and pricing requests"
2295
- }
2296
- }
2297
- },
2298
- "SharedInboxResponse": {
2299
- "description": "Shared inbox configuration with all associated metadata.",
2300
- "allOf": [
2301
- {
2302
- "$ref": "#/components/schemas/SettingMeta"
2303
- },
2304
- {
2305
- "type": "object",
2306
- "required": [
2307
- "id",
2308
- "name",
2309
- "color",
2310
- "assignees",
2311
- "bucket_id"
2312
- ],
2313
- "properties": {
2314
- "id": {
2315
- "type": "string",
2316
- "description": "Unique identifier of the shared inbox",
2317
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
2318
- },
2319
- "name": {
2320
- "type": "string",
2321
- "description": "Display name of the shared inbox",
2322
- "example": "Customer Support"
2323
- },
2324
- "color": {
2325
- "type": "string",
2326
- "description": "Hex color code for visual identification",
2327
- "example": "#4CAF50"
2328
- },
2329
- "assignees": {
2330
- "type": "array",
2331
- "description": "List of user IDs assigned to this inbox",
2332
- "default": [],
2333
- "items": {
2334
- "type": "string"
2335
- },
2336
- "example": [
2337
- "user-123",
2338
- "user-456"
2339
- ]
2340
- },
2341
- "description": {
2342
- "type": "string",
2343
- "description": "Description of the inbox purpose",
2344
- "example": "Incoming customer support requests"
2345
- },
2346
- "bucket_id": {
2347
- "type": "string",
2348
- "description": "ID of the associated storage bucket for messages",
2349
- "example": "bucket-xyz"
2350
- }
2351
- }
2352
- }
2353
- ]
2354
- },
2355
- "SettingsResponse": {
2356
- "oneOf": [
2357
- {
2358
- "type": "array",
2359
- "items": {
2360
- "$ref": "#/components/schemas/Setting"
2361
- }
2362
- },
2363
- {
2364
- "$ref": "#/components/schemas/Setting"
2365
- }
2366
- ]
2367
- },
2368
- "ConnectedOutlookEmail": {
2369
- "type": "object",
2370
- "description": "Mapping between an Outlook email and its Outlook Connection.\nThis tracks which provider/tenant provisions each Outlook email.\n",
2371
- "required": [
2372
- "outlook_email"
2373
- ],
2374
- "properties": {
2375
- "outlook_email": {
2376
- "type": "string",
2377
- "format": "email",
2378
- "description": "The Outlook shared mailbox email address"
2379
- },
2380
- "tenant_id": {
2381
- "type": "string",
2382
- "description": "Azure AD Tenant ID that provisions this mailbox"
2383
- },
2384
- "provider": {
2385
- "type": "string",
2386
- "enum": [
2387
- "outlook"
2388
- ],
2389
- "description": "Provider type (for future extensibility)"
2390
- },
2391
- "connected_at": {
2392
- "type": "string",
2393
- "format": "date-time",
2394
- "description": "When the mailbox was connected"
2395
- },
2396
- "connected_by_user_id": {
2397
- "type": "string",
2398
- "description": "User who connected this mailbox"
2399
- }
2400
- }
2401
- },
2402
- "OutlookConnectionError": {
2403
- "type": "object",
2404
- "required": [
2405
- "error"
2406
- ],
2407
- "properties": {
2408
- "error": {
2409
- "type": "string",
2410
- "description": "Error code or message from the OAuth flow."
2411
- },
2412
- "error_description": {
2413
- "type": "string",
2414
- "description": "Human-readable description of the error."
2415
- },
2416
- "admin_consent_url": {
2417
- "type": "string",
2418
- "format": "uri",
2419
- "description": "URL for tenant admin to grant consent, if applicable."
2420
- }
2421
- }
2422
- },
2423
- "OutlookConnectionStatus": {
2424
- "type": "object",
2425
- "required": [
2426
- "status",
2427
- "action",
2428
- "action_label",
2429
- "tenant_id"
2430
- ],
2431
- "properties": {
2432
- "status": {
2433
- "type": "string",
2434
- "enum": [
2435
- "connected",
2436
- "expired",
2437
- "pending_auth",
2438
- "not_connected"
2439
- ],
2440
- "description": "Current connection status:\n- pending_auth: Admin consent granted, waiting for user OAuth\n- connected: Fully connected with valid tokens\n- expired: Tokens expired, need to re-authenticate\n- not_connected: No connection, initiate OAuth\n"
2441
- },
2442
- "action": {
2443
- "type": "string",
2444
- "enum": [
2445
- "connect",
2446
- "authorize",
2447
- "reconnect",
2448
- "none"
2449
- ],
2450
- "description": "Action for UI to take (all call GET /outlook/connect):\n- connect: No connection, initiate OAuth\n- authorize: Admin consent done, complete OAuth\n- reconnect: Re-authenticate expired session\n- none: Fully connected, no action needed\n"
2451
- },
2452
- "connected_by_display_name": {
2453
- "type": "string",
2454
- "description": "Display name of user who connected"
2455
- },
2456
- "connected_by_email": {
2457
- "type": "string",
2458
- "format": "email",
2459
- "description": "Email of the user who connected"
2460
- },
2461
- "connected_by_user_id": {
2462
- "type": "string",
2463
- "description": "Azure AD Object ID of user who connected"
2464
- },
2465
- "connected_at": {
2466
- "type": "string",
2467
- "format": "date-time",
2468
- "description": "When the connection was established"
2469
- },
2470
- "updated_at": {
2471
- "type": "string",
2472
- "format": "date-time",
2473
- "description": "When the connection was last updated"
2474
- },
2475
- "tenant_id": {
2476
- "type": "string",
2477
- "description": "Microsoft Azure AD tenant ID"
2478
- },
2479
- "scopes": {
2480
- "type": "array",
2481
- "items": {
2482
- "type": "string"
2483
- },
2484
- "description": "Granted permission scopes"
2485
- },
2486
- "expires_at": {
2487
- "type": "string",
2488
- "format": "date-time",
2489
- "description": "When the current access token expires"
2490
- },
2491
- "is_token_valid": {
2492
- "type": "boolean",
2493
- "description": "Whether the current token is still valid"
2494
- }
2495
- }
2496
- },
2497
- "SignatureSetting": {
2498
- "type": "string",
2499
- "description": "Setting that allows to add a signature.",
2500
- "enum": [
2501
- "signature"
2502
- ]
2503
- },
2504
- "EmailDomainSetting": {
2505
- "type": "string",
2506
- "description": "Setting that allows to add a custom domain. For e.g; doe.com",
2507
- "enum": [
2508
- "email_domain"
2509
- ]
2510
- },
2511
- "EmailAddressSetting": {
2512
- "type": "string",
2513
- "description": "Setting that allows to add an email address on the custom domain. For e.g; john@doe.com",
2514
- "enum": [
2515
- "email_address"
2516
- ]
2517
- },
2518
- "WhitelistEmailAddressSetting": {
2519
- "type": "string",
2520
- "description": "- Setting that specifies a list of addresses exempt from being flagged as duplicate emails.\n- An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.\n",
2521
- "enum": [
2522
- "whitelist_email_address"
2523
- ]
2524
- },
2525
- "RestrictDuplicatesWithinSetting": {
2526
- "type": "string",
2527
- "description": "- Restrict duplicates within:\n * 10s\n * 5m\n * 1d\n * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.\n- Defaults to 3 minutes\n- Negative values will be treated same as positive values\n- If not set, defaults to 3 min\n- If set as 0, then the no email will be treated as a duplicate\n- Cannot have multiple values\n",
2528
- "enum": [
2529
- "restrict_duplicates_within"
2530
- ]
2531
- },
2532
- "SettingType": {
2533
- "oneOf": [
2534
- {
2535
- "$ref": "#/components/schemas/SignatureSetting"
2536
- },
2537
- {
2538
- "$ref": "#/components/schemas/EmailDomainSetting"
2539
- },
2540
- {
2541
- "$ref": "#/components/schemas/EmailAddressSetting"
2542
- },
2543
- {
2544
- "$ref": "#/components/schemas/WhitelistEmailAddressSetting"
2545
- },
2546
- {
2547
- "$ref": "#/components/schemas/RestrictDuplicatesWithinSetting"
2548
- }
2549
- ]
2550
- },
2551
- "Setting": {
2552
- "type": "object",
2553
- "description": "Generic setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n- **restrict_duplicates_within**: Uses `value` (time duration)\n",
2554
- "required": [
2555
- "type"
2556
- ],
2557
- "properties": {
2558
- "id": {
2559
- "type": "string",
2560
- "description": "Unique identifier of the setting",
2561
- "example": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"
2562
- },
2563
- "name": {
2564
- "type": "string",
2565
- "description": "Display name of the setting (used for signatures)",
2566
- "example": "Default Signature"
2567
- },
2568
- "org_id": {
2569
- "type": "string",
2570
- "description": "Organization ID that owns this setting",
2571
- "example": "org-123"
2572
- },
2573
- "type": {
2574
- "$ref": "#/components/schemas/SettingType"
2575
- },
2576
- "value": {
2577
- "type": "string",
2578
- "description": "The setting value. Interpretation depends on type:\n- signature: Plain text version of the signature\n- email_domain: Domain name (e.g., \"yourcompany.com\")\n- whitelist_email_address: Email address to whitelist\n- restrict_duplicates_within: Time duration (e.g., \"5m\", \"1d\")\n",
2579
- "example": "Best regards, The Team"
2580
- },
2581
- "html": {
2582
- "type": "string",
2583
- "description": "HTML content (only applicable for signature type)",
2584
- "example": "<p>Best regards,<br/><strong>The Team</strong></p>"
2585
- },
2586
- "created_at": {
2587
- "type": "string",
2588
- "description": "ISO 8601 timestamp when the setting was created",
2589
- "example": "2024-01-15T10:30:00Z"
2590
- },
2591
- "updated_at": {
2592
- "type": "string",
2593
- "description": "ISO 8601 timestamp when the setting was last updated",
2594
- "example": "2024-01-20T14:45:00Z"
2595
- },
2596
- "created_by": {
2597
- "type": "string",
2598
- "description": "User ID of the creator",
2599
- "example": "user-123"
2600
- },
2601
- "updated_by": {
2602
- "type": "string",
2603
- "description": "User ID of the last editor",
2604
- "example": "user-456"
2605
- }
2606
- },
2607
- "additionalProperties": true
2608
- },
2609
- "Domain": {
2610
- "type": "object",
2611
- "description": "Custom email domain configuration.",
2612
- "properties": {
2613
- "domain": {
2614
- "type": "string",
2615
- "description": "The domain name to add or verify. Can be a root domain or subdomain.\nExamples: \"yourcompany.com\", \"mail.yourcompany.com\"\n",
2616
- "example": "mail.yourcompany.com"
2617
- }
2618
- }
2619
- }
2620
- }
2621
- },
2622
- "servers": [
2623
- {
2624
- "url": "https://email-settings.sls.epilot.io"
2625
- }
2626
- ]
2627
- }