Send Message

POST

https://api.fortresstech.io/v1/messages

POST

/v1/messages

$ curl -X POST https://api.fortresstech.io/v1/messages \
>      -H "Content-Type: application/json" \
>      -d '{
>   "content": "content",
>   "idempotencyId": "idempotencyId"
> }'

1 {
2   "id": "id",
3   "conversationId": "conversationId",
4   "type": "OUTBOUND",
5   "content": "content",
6   "messageStatus": "messageStatus",
7   "messageStatusReason": "messageStatusReason",
8   "messageSid": "messageSid",
9   "customerStatus": "customerStatus",
10   "idempotencyId": "idempotencyId",
11   "isAutomated": true,
12   "needsHelp": true,
13   "needsHelpDetails": {
14     "reason": "reason",
15     "flaggedByType": "agent",
16     "flaggedById": "flaggedById",
17     "flaggedAt": "2024-01-15T09:30:00Z",
18     "resolvedByType": "agent",
19     "resolvedById": "resolvedById",
20     "resolvedAt": "2024-01-15T09:30:00Z"
21   },
22   "subject": "subject",
23   "emailAddress": "emailAddress",
24   "attachments": [
25     {
26       "key": "key",
27       "bucket": "bucket",
28       "type": "type",
29       "url": "url"
30     }
31   ],
32   "metadata": {
33     "key": "value"
34   },
35   "organizationId": "organizationId",
36   "customerId": "customerId",
37   "prospectId": "prospectId",
38   "userId": "userId",
39   "createdAt": "2024-01-15T09:30:00Z",
40   "updatedAt": "2024-01-15T09:30:00Z"
41 }

Available by Request

Send a message to a customer or prospect. Supply exactly one of customerId or prospectId. Supplying both is not rejected: customerId takes precedence and the prospectId you sent is ignored, so the message is attributed to the customer.

Fortress resolves the recipient’s contact details and property phone number, appends the message to the existing conversation with that recipient (creating one if none exists), and hands it to the carrier.

A 201 means the message was accepted, not that it was delivered. The returned messageStatus will be PROCESSING while delivery is in flight; poll GET /messages/{messageId} until it reaches a terminal status of DELIVERED, UNDELIVERED, or FAILED.

idempotencyId is required. Reusing a key returns the message created by the original request instead of sending a duplicate, so a retry after a network timeout is always safe.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Send a message to a customer or prospect. Supply exactly one of `customerId` or `prospectId`. Supplying both is not rejected: `customerId` takes precedence and the `prospectId` you sent is ignored, so the message is attributed to the customer. Fortress resolves the recipient's contact details and property phone number, appends the message to the existing conversation with that recipient (creating one if none exists), and hands it to the carrier. A `201` means the message was accepted, not that it was delivered. The returned `messageStatus` will be `PROCESSING` while delivery is in flight; poll `GET /messages/{messageId}` until it reaches a terminal status of `DELIVERED`, `UNDELIVERED`, or `FAILED`. `idempotencyId` is required. Reusing a key returns the message created by the original request instead of sending a duplicate, so a retry after a network timeout is always safe. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Request

This endpoint expects an object.

Response

The message was accepted for delivery.

Errors

400

Send Message Request Bad Request Error

404

Send Message Request Not Found Error

422

Send Message Request Unprocessable Entity Error