Create a Communication

Log an email or SMS message that was exchanged with a renter outside of Funnel so it appears in the renter's Funnel Messenger thread and guest card timeline. Use `incoming` as the direction when the renter sent the message (e.g. the renter replied through your platform's inbox) and `outgoing` when your platform sent the message to the renter. Incoming messages are attributed to the renter, so `from_address` must be an email address or phone number that exists on the renter's Funnel record. This endpoint records the message only; it does not deliver it. To send a message to a renter, use Send communication. For chatbot or live-chat transcripts, use Create a Chat Conversation.

POST

/api/partners/v1/community/:community_id/renters/:funnel_renter_id/communication/

Request

Example requestPOSTapplication/json

curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -d '{
      "direction": "incoming",
      "message_type": "email",
      "subject": "Re: Scheduling a tour",
      "message": "What time are you available for a tour?",
      "to_addresses": [
        "leasing@example.com"
      ],
      "from_address": "renter@example.com"
    }' \
    "https://api.funnelleasing.com/api/partners/v1/community/1234/renters/:funnel_renter_id/communication/"

Response

Example responseJSON200 · application/json

{
  "message": {
    "id": 456,
    "direction": "string",
    "subject": "string",
    "text": "string",
    "to_addresses": [],
    "from_address": "string",
    "type": 0
  }
}