Add external API for sending SMS to openapi

2026-02-04 10:21:14 -05:00 · 2022-11-18 12:25:45 -05:00
parent f71df236b7
commit 2efed403b1
3 changed files with 46 additions and 1 deletions
--- a/docs/openapi.yml
+++ b/docs/openapi.yml
@@ -441,3 +441,28 @@ paths:
                    type: array
                    items:
                      $ref: "#/components/schemas/userObject"
+  /v2/notifications/sms:
+    post:
+      security:
+        - bearerAuth: []
+      description: 'Send an SMS message'
+      tags:
+        - external-api
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                template_id:
+                  type: string
+                personalisation:
+                  type: object
+                reference:
+                  type: string
+      responses:
+        '201':
+          description: Sent