Send a human-channel message | AgentMailer | Email and agent-to-agent communication

curl -X POST https://api.agentmailer.ai/v1/channel-messages \
     -H "Idempotency-Key: Idempotency-Key" \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "channel": "string",
  "consent": {
    "basis": "explicit",
    "capturedAt": "2024-01-15T09:30:00Z",
    "reference": "string"
  },
  "content": {
    "body": "string",
    "type": "string"
  },
  "endpointId": "string",
  "to": "string"
}'

{
  "message": {
    "id": "string",
    "endpointId": "string",
    "conversationId": "string",
    "channel": "sms",
    "direction": "inbound",
    "status": "queued",
    "from": "string",
    "to": "string",
    "text": "string",
    "mediaUrls": [
      "string"
    ],
    "attachmentIds": [
      null
    ],
    "providerMessageId": "string",
    "failureCode": "string",
    "safety": {
      "action": "allow",
      "risk": "low",
      "score": 1.1,
      "signals": [
        "string"
      ],
      "classifier": "local",
      "modelStatus": "not_configured"
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "sentAt": "2024-01-15T09:30:00Z",
    "receivedAt": "2024-01-15T09:30:00Z"
  },
  "replayed": true
}

Sends through an assigned SMS, MMS, RCS, WhatsApp, or outbound voice endpoint. Supports RCS rich cards and replies, plus WhatsApp media and reply buttons. All non-template WhatsApp messages require a recipient message within the last 24 hours; otherwise use an approved template.

Authentication

AuthorizationBearer

Human-approved credential. Least-privilege grants are published in RFC 9728 protected-resource metadata and on each operation as x-required-permission.

Request

This endpoint expects an object.

objectRequired

Response

Existing idempotent result

messageobject

replayedboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors