Invites
invite.updated
An invite is updated, such as through PATCH /v1/invites/{id}. Changing only metadata doesn’t send this event.
WEBHOOK
invite.updated
{
"event_id": "3f6c2a91-7d4e-4b8a-9c15-2e8f0a6b4d73",
"event_type": "invite.updated",
"occurred_at": "2025-07-28T18:27:54.690Z",
"data": {
"invite": {
"id": "inv_8f3k2jd9slq02mxp",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"obligee": "Acme Property Management LLC",
"status": "created",
"application_id": null,
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-08-31",
"monthly_rent": 340000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/q7ghmgtaavp37krc",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}
}
}Body
application/json
Identifier of the event that triggered this webhook. It stays the same when a delivery is retried, so you can use it to deduplicate. Treat it as an opaque string; its format varies by event type.
Denotes the resource and what happened to it.
UTC timestamp when the source event occurred.
Example:
"2025-07-28T18:27:54.690Z"
Show child attributes
Show child attributes
Response
200
Your endpoint should return 2xx
⌘I
{
"event_id": "3f6c2a91-7d4e-4b8a-9c15-2e8f0a6b4d73",
"event_type": "invite.updated",
"occurred_at": "2025-07-28T18:27:54.690Z",
"data": {
"invite": {
"id": "inv_8f3k2jd9slq02mxp",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"obligee": "Acme Property Management LLC",
"status": "created",
"application_id": null,
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-08-31",
"monthly_rent": 340000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/q7ghmgtaavp37krc",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}
}
}