Send a ResApp push notification

POST

/api/partners/v1/community/{community_id}/renters/{funnel_renter_id}/units/{funnel_unit_id}/push-notification/

Send a ResApp push notification to a given renter and unit

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

funnel_unit_id

required

string

The Funnel unit id.

Example

12345

Request Body

object

type

string

Allowed values: RENEWAL

RENEWAL

context

Depending on the type of notification, this is an object containing the relevant push notification data, i.e. “lease_end_date”

object

Responses

201

Push notification scheduled

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

An active lease could not be matched using the provided community, renter, and unit.

object

error_type

string

LeaseNotFound

message

string

Could not find active lease for client.