invite.updated, invite_recipient.added, invite_recipient.updated or invite_recipient.removed. A request that changes only metadata, or doesn’t change anything, doesn’t send one. See Webhooks.
Errors from these endpoints include a machine-readable error_code, and a validation_error lists each rejected field in field_errors. See Error codes.
Updating an Invite
Endpoint:PATCH /v1/invites/:id
Purpose: Updates the property, unit, coverage level, lease terms or metadata of an invite. Only the fields you send are changed.
Example Request
unit_id (for example, unit_u7yr0vt3r9yk0c) or a new lease.unit_address. To move it to a different property, send the new property_id together with a unit_id or a complete lease.unit_address.
Adding a Recipient
Endpoint:POST /v1/invites/:id/invite-recipients
Purpose: Adds a recipient to the invite. The response includes the new recipient’s invite link.
Example Request
Updating a Recipient
Endpoint:PATCH /v1/invite-recipients/:id
Purpose: Updates a recipient’s first_name, last_name, email, phone_number or metadata. Changing email gives the recipient a new link, and the previous link stops working. The new email can’t already be used by another recipient on the invite. Sending null for phone_number or metadata clears it.
Example Request
Removing a Recipient
Endpoint:DELETE /v1/invite-recipients/:id
Purpose: Removes the recipient from the invite. Their invite link stops working immediately. A successful request returns 204 No Content with an empty body.
Example Request
Canceling an Invite
An invite can be canceled at any point before it converts into an application. Canceling an invite is how you retire an invite that is no longer valid, for example when the prospective resident withdraws, the unit is leased to someone else, or the invite was created by mistake. Endpoint:POST /v1/invites/:id/cancel
Purpose: Cancels an invite that has not yet converted into an application and moves its status to canceled. Once canceled, the invite and its recipient links can no longer be used to start an application, and the invite can no longer be amended.
Path Parameter: id (string, required) is the unique identifier for the invite.
Request Body: The body is optional. If provided, it may contain a single field:
Response: The canceled invite, with
status set to canceled.
When the invite is successfully canceled, we will emit an invite.status.canceled webhook to your registered URL if you are subscribed for this event type. In the event that the invite had already been canceled, then the operation is effectively a no-op; the endpoint will return with 200 but will not emit a new invite.status.canceled webhook.