Send communication

POST

/api/partners/v1/community/{community_id}/renters/{funnel_renter_id}/send-communication/

Send communication via sms/email to the given renter

Authorizations

• BasicAuth
• BearerAuth

Parameters

Path Parameters

community_id

required

string

The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that ID to Funnel.

Examples

Funnel Community ID

The raw integer Funnel ID of a community.

1234

Funnel Community Syndication ID

The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.

P1234-567

Partner ID

The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.

partner-id:apts123

funnel_renter_id

required

string

The client’s funnel id (often referred to as client id or prospect id), this will look like ‘1234’.

Example

12345

Request Body

object

message_type

string

Allowed values: sms email default

default

message_text_body

string

your documents are ready to be signed

message_html_body

string

<h1>Documents ready</h1><br/>Your documents to renew are ready, you can sign them.

message_template_id

integer

message_subject

string

Document to sign

to_addresses

Array<string>

Responses

200

Success

object

status

boolean

true

messagesQueued

Array<object>

object

[
  {
    "funnel_person_id": 123,
    "renter_person_xid": 856,
    "email": "na@na.com",
    "from_email_address": "na@na.com",
    "message": "This is an email message to the renter",
    "message_type": "email",
    "message_id": 123,
    "subject": "This is a subject"
  },
  {
    "funnel_person_id": 123,
    "renter_person_xid": 856,
    "phone": 1234567890,
    "from_phone_number": 1234567890,
    "message": "This is a sms message to the renter",
    "message_type": "sms",
    "message_id": 123
  }
]

messagesFailed

Array<object>

object

[
  {
    "funnel_person_id": 457,
    "renter_person_xid": 632,
    "phone": 1456123789,
    "message": "your documents are ready",
    "message_type": "sms",
    "message_id": "7wge34"
  },
  {
    "email": "na@na.com",
    "message_type": "email",
    "error_message": "Unable to match the 'na@na.com'."
  }
]

400

401

403

We were unable to authenticate your request with the provided API key.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.

404

A community with this ID does not exist.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.