Edit appointment

PUT

/api/partners/v1/community/{community_id}/appointments/{appointment_id}/

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

appointment_id

required

integer

Request Body

Schema for updating appointment details, any fields not provided in the request will not be updated.

object

status

string

Allowed values: no-show complete

notes

string

message

Prospect notes or message submitted with the appointment

string

Looking forward to my appointment

pms_units

Array<object>

object

pms_property_id

required

string

pms_unit_id

required

string

Responses

200

Appointment successfully updated.

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 or appointment with this ID does not exist.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.