Create Sms — Hail docs

Header Parameters

authorization?string|null

Idempotency-Key?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

recipient_consent*Recipient Consent

Attestation that you have obtained the lawful consent required to contact this recipient. Hail does not verify consent itself — you are responsible for a lawful basis under TCPA/ePrivacy/PECR/CAN-SPAM/GDPR as applicable. Rejected (422) if not true.

consent_source?|

Where/how consent was obtained (e.g. 'signup form', 'prior customer relationship'). Required (non-empty) when message_type is 'marketing'.

consent_obtained_at?|

When consent was obtained, if known.

message_type?Message Type

'marketing' additionally requires a non-empty consent_source. Use 'informational' for transactional/service communications.

Default"informational"

Value in

"marketing"
"informational"

to*To

from?string|null

body*Body

Length1 <= length <= 1600

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/sms" \  -H "Content-Type: application/json" \  -d '{    "recipient_consent": true,    "to": "string",    "body": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",  "from_e164": "string",  "to_e164": "string",  "direction": "outbound",  "status": "queued",  "body": "string",  "provider_message_sid": "string",  "segment_count": 0,  "error_code": "string",  "requested_at": "2019-08-24T14:15:22Z",  "sent_at": "2019-08-24T14:15:22Z"}

Header Parameters

Request Body

Response Body

201application/json

422application/json

429

`application/json`

`application/json`