Skip to content
Funnel Leasing

Create a Task

POST
/api/partners/v1/community/{community_id}/renters/{funnel_renter_id}/task/

Create a task and assign it to team or agent

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “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_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

Section titled “Request Body ”
object
due_date
required

Task due date

string format: date 
2023-10-05
task_type
required

Task Type

string
Allowed values: CUSTOM FOLLOW_UP BIRTHDAY SEND_EMAIL SEND_SMS MAKE_A_CALL
group_assignment_assignee

Whether to assign the task to the group assignment assignee

boolean
assignee_funnel_user_id

Agent IT to assign task to

integer
nullable
description
required

Task Description

string
Call about renewal options
task_category

Task Category ID

integer
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Task successfully created/updated.

400

Section titled “400 ”

401

Section titled “401 ”

403

Section titled “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

Section titled “404 ”

A community with this ID does not exist.

object
error_type
string
CommunityNotFound
message
string
Could not find community with corresponding ID.