Update a task

PUT

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

Update a task

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

task_id

required

string

The primary key of the task.

Example

123

Request Body

object

due_date

Task due date

string format: date

2023-10-05

task_type

Task Type

string

Allowed values: CUSTOM FOLLOW_UP BIRTHDAY SEND_EMAIL SEND_SMS MAKE_A_CALL

description

Task Description

string

Call about renewal options

status

string

Allowed values: Active Canceled Completed Not Applicable

task_category

Task Category ID

integer

nullable

Responses

200

Task successfully updated.

object

task_id

string

204

No change on the server.

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.