Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn’t been canceled, expired, or converted into an application. Changing only metadata doesn’t send an invite.updated webhook.
{
"message": "validation error: coverage_level: coverage_level must be one of low, medium, high.",
"error_code": "validation_error",
"field_errors": [
{
"field": "coverage_level",
"code": "invalid_value",
"message": "coverage_level must be one of low, medium, high"
}
],
"object": "error"
}
Change the coverage tier for the bond, which sets the number of months of rent it protects, from low (lowest) to high (highest). It is resolved to a coverage package using the coverages set up for the property, and every tier is subject to property support and applicant screening.
Key-value object. Replaces the existing metadata in full; send null to clear it. Each key must be a string, and values can be strings, numbers, booleans, or null.
The legal contract between a property manager and the tenant, as represented on invites. Identical to Lease, plus rent concession fields that are accepted when creating an invite and returned on invite responses. One of unit_address or unit_id is required.
Optional key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.
The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.
{
"message": "validation error: coverage_level: coverage_level must be one of low, medium, high.",
"error_code": "validation_error",
"field_errors": [
{
"field": "coverage_level",
"code": "invalid_value",
"message": "coverage_level must be one of low, medium, high"
}
],
"object": "error"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"The Guarantors API","description":"Developer documentation for TheGuarantors Embed API: invites, applications, bonds, webhooks and the sandbox.","colors":{"primary":"#3DB157","light":"#3DB157","dark":"#3DB157"},"logo":{"light":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7","dark":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=7bc091265f808f82f21f214c0ea22d2f"},"favicon":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/favicon.png?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=73fef4218af15ee58b6e5ad76682046c","footer":{"socials":{"linkedin":"https://www.linkedin.com/company/the-guarantors","x":"https://twitter.com/The_Guarantors","facebook":"https://www.facebook.com/TheGuarantors","instagram":"https://www.instagram.com/theguarantors"},"links":[{"header":" ","items":[{"label":"Privacy Policy","href":"https://www.theguarantors.com/privacy"},{"label":"Terms of Service","href":"https://www.theguarantors.com/terms"},{"label":"Legal / Regulatory Notice","href":"https://www.theguarantors.com/legal-regulatory"}]},{"header":" ","items":[{"label":"Notice of Collection","href":"https://www.theguarantors.com/notice-of-collection"},{"label":"Trust Center","href":"https://trust.theguarantors.com"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"theguarantors-2e3c1083","hasAudioNarration":false,"actualSubdomain":"theguarantors-2e3c1083","customDomains":["docs.theguarantors.com"],"gitSource":{"type":"github","owner":"theguarantors","repo":"tg-edge-service","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af20a0d60eda55d1f7e6246","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Application API","count":30},{"language":"default","tag":"Docs","count":12},{"language":"default","tag":"Schemas","count":10},{"language":"default","tag":"Applications","count":9},{"language":"default","tag":"Invites","count":7},{"language":"default","tag":"Core Concepts","count":6},{"language":"default","tag":"Invite Recipients","count":6},{"language":"default","tag":"Bonds","count":4},{"language":"default","tag":"Applicants","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-area table td:first-child code{white-space:nowrap;overflow-wrap:normal}"}],"page":{"pagePath":"application-api/invites/update-an-invite","slug":"/application-api/invites/update-an-invite","pageMetadata":{"title":"Update an invite","description":"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application. Changing only metadata doesn't send an invite.updated webhook.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invites/{id}","href":"/application-api/invites/update-an-invite","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn’t been canceled, expired, or converted into an application. Changing only metadata doesn’t send an invite.updated webhook.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update an invite","description":"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application. Changing only metadata doesn't send an invite.updated webhook.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invites/{id}","href":"/application-api/invites/update-an-invite","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["37c68e76-2171-4724-95e9-80fff86fbc48"],"description":"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application. Changing only metadata doesn't send an invite.updated webhook.","tags":["Invites"],"summary":"Update an invite","parameters":["880bb5fa-9082-43bd-8b88-a4aedba2c377"],"requestBody":"b70f4065-96b0-4c98-a7fa-64abc47062a1","responses":{"200":"57fadf7e-63ff-465d-bc46-46832699b519","400":"20432e82-a91f-43b1-a022-bb7acb12c3cb","401":"f98ca859-8dfa-467c-9f9f-44df01b6c4a6","403":"23ed4bd3-25e3-484d-81b2-71fd2118ef4b","404":"163fce83-3505-4594-a6cf-aa926f36d1f1","409":"bf9c1d7a-dbcd-4246-8ee5-11d7e125442b","422":"2de8668e-ffbf-4d5d-801c-0f76f220a364","429":"f5007bbc-5bcb-4679-b202-2b9cf22ae9dd","500":"c66223cd-7efb-48e0-a749-5616ebe92a9c"},"method":"patch","type":"path","servers":["4c923e28-1932-4d68-820c-f5aa1183a0de"],"path":"/v1/invites/{id}","baseUrlOptions":["https://api.theguarantors.com"],"title":"Update an invite","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"880bb5fa-9082-43bd-8b88-a4aedba2c377":{"description":"Invite ID","name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Invite ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"coverage_level":{"description":"Change the coverage tier for the bond, which sets the number of months of rent it protects, from `low` (lowest) to `high` (highest). It is resolved to a coverage package using the coverages set up for the property, and every tier is subject to property support and applicant screening.","type":"string","enum":["low","medium","high"],"example":"medium","uniqueKey":"coverage_level","typeLabel":"enum\u003cstring>"},"lease":{"type":"object","properties":{"end_date":{"description":"YYYY-MM-DD. Must be after `start_date`.","type":"string","format":"date","example":"2027-08-31","uniqueKey":"lease.end_date","typeLabel":"string\u003cdate>"},"free_rent_amount":{"description":"Free rent amount in cents.","type":"integer","maximum":5000000,"minimum":0,"example":0,"uniqueKey":"lease.free_rent_amount","typeLabel":"integer"},"monthly_rent":{"description":"Monthly rent in cents.","type":"integer","minimum":1,"example":160000,"uniqueKey":"lease.monthly_rent","typeLabel":"integer"},"prepaid_rent_amount":{"description":"Prepaid rent amount in cents.","type":"integer","maximum":5000000,"minimum":0,"example":0,"uniqueKey":"lease.prepaid_rent_amount","typeLabel":"integer"},"start_date":{"description":"YYYY-MM-DD","type":"string","format":"date","example":"2026-03-01","uniqueKey":"lease.start_date","typeLabel":"string\u003cdate>"},"unit_address":{"type":"object","description":"Can't be sent together with `unit_id`. Changing `city`, `state` or `postal_code` also requires a new `property_id`.","properties":{"city":{"type":"string","minLength":1,"example":"New York","uniqueKey":"lease.unit_address.city","typeLabel":"string"},"line1":{"type":"string","minLength":1,"example":"123 Main St","uniqueKey":"lease.unit_address.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","example":"Apt 2B","uniqueKey":"lease.unit_address.line2.oneOf.0","typeLabel":"string"},{"type":"null","example":"Apt 2B","uniqueKey":"lease.unit_address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.unit_address.line2","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"example":"10001","uniqueKey":"lease.unit_address.postal_code","typeLabel":"string"},"state":{"type":"string","minLength":1,"example":"NY","uniqueKey":"lease.unit_address.state","typeLabel":"string"}},"uniqueKey":"lease.unit_address","typeLabel":"object"}},"uniqueKey":"lease","typeLabel":"object"},"metadata":{"oneOf":[{"description":"Key-value object. Replaces the existing metadata in full; send `null` to clear it. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"object","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"description":"Key-value object. Replaces the existing metadata in full; send `null` to clear it. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"null","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"property_id":{"description":"Move the invite to a different property. Must be sent together with `unit_id` or a complete `lease.unit_address`.","type":"string","example":"prop_ve2x7i0j6psdizy7","uniqueKey":"property_id","typeLabel":"string"},"unit_id":{"description":"Move the invite to a different unit. Can't be sent together with `lease.unit_address`.","type":"string","example":"unit_u7yr0vt3r9yk0c","uniqueKey":"unit_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"coverage_level":"medium","lease":{"end_date":"2027-08-31","monthly_rent":160000}},"examples":{"Example":{"title":"Example","value":{"coverage_level":"medium","lease":{"end_date":"2027-08-31","monthly_rent":160000}}}},"exampleType":"examples"}},"description":"Fields to update","required":true,"exampleType":"examples"},"responses":{"57fadf7e-63ff-465d-bc46-46832699b519":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","invite_recipients","lease","object","property_id","status"],"properties":{"id":{"type":"string","example":"inv_01HQ8X","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"invite_recipients":{"type":"array","items":{"type":"object","required":["email","first_name","id","last_name","link","object"],"properties":{"email":{"type":"string","format":"email","example":"dana.whitfield@example.com","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","example":"Dana","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].first_name","typeLabel":"string"},"id":{"type":"string","example":"ivre_01HQ8Y","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].id","typeLabel":"string"},"last_name":{"type":"string","example":"Whitfield","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].last_name","typeLabel":"string"},"link":{"description":"URL that links the prospective renter to their prefilled TheGuarantors application.","type":"string","format":"uri","example":"https://qualify.theguarantors.com/invite/sign-up/k3v9q2m7x1p4r8tz","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].link","typeLabel":"string\u003curi>"},"object":{"type":"string","example":"invite_recipient","isRequired":true,"uniqueKey":"invite_recipients.items.[INDEX].object","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","uniqueKey":"invite_recipients.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invite_recipients.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_recipients.items.[INDEX].metadata","typeLabel":"object | null"},"phone_number":{"oneOf":[{"description":"Phone number in E.164 format, for example `+12125551234`. Spaces and formatting characters such as parentheses, dashes and dots are removed. A 10-digit number without a country code is treated as a US number and gets `+1` added. Include the `+` and country code for any other number.","type":"string","example":"+15551234567","uniqueKey":"invite_recipients.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"description":"Phone number in E.164 format, for example `+12125551234`. Spaces and formatting characters such as parentheses, dashes and dots are removed. A 10-digit number without a country code is treated as a US number and gets `+1` added. Include the `+` and country code for any other number.","type":"null","example":"+15551234567","uniqueKey":"invite_recipients.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_recipients.items.[INDEX].phone_number","typeLabel":"string | null"}},"uniqueKey":"invite_recipients.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"invite_recipients","typeLabel":"object[]"},"lease":{"type":"object","description":"The legal contract between a property manager and the tenant, as represented on invites. Identical to Lease, plus rent concession fields that are accepted when creating an invite and returned on invite responses. One of unit_address or unit_id is required.","required":["monthly_rent","object","unit_address"],"properties":{"monthly_rent":{"description":"Monthly rent in cents.","type":"integer","minimum":1,"example":280000,"isRequired":true,"uniqueKey":"lease.monthly_rent","typeLabel":"integer"},"object":{"type":"string","example":"lease","isRequired":true,"uniqueKey":"lease.object","typeLabel":"string"},"unit_address":{"type":"object","description":"The unit address that would be printed on the lease, and therefore the Lease Guarantee surety bond. If you do not store the address with separate address line 1s and address line 2, put the full unit address in the address line 1.","required":["city","line1","object","postal_code","state"],"properties":{"city":{"description":"City which this address is located in","type":"string","example":"Brooklyn","isRequired":true,"uniqueKey":"lease.unit_address.city","typeLabel":"string"},"line1":{"description":"Address line 1","type":"string","example":"412 Halsey St","isRequired":true,"uniqueKey":"lease.unit_address.line1","typeLabel":"string"},"object":{"type":"string","example":"address","isRequired":true,"uniqueKey":"lease.unit_address.object","typeLabel":"string"},"postal_code":{"description":"Postal or Zip code for this address","type":"string","example":"11233","isRequired":true,"uniqueKey":"lease.unit_address.postal_code","typeLabel":"string"},"state":{"description":"State which this address is located in","type":"string","example":"NY","isRequired":true,"uniqueKey":"lease.unit_address.state","typeLabel":"string"},"line2":{"oneOf":[{"description":"Address line 2","type":"string","example":"Apt 3R","uniqueKey":"lease.unit_address.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2","type":"null","example":"Apt 3R","uniqueKey":"lease.unit_address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.unit_address.line2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"lease.unit_address","typeLabel":"object"},"end_date":{"oneOf":[{"description":"The date when this lease expires.","type":"string","format":"date","example":"2027-08-31","uniqueKey":"lease.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease expires.","type":"null","format":"date","example":"2027-08-31","uniqueKey":"lease.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.end_date","typeLabel":"string\u003cdate> | null"},"free_rent_amount":{"description":"The amount of free rent (in cents) granted to the applicant.","type":"integer","maximum":5000000,"minimum":0,"example":0,"uniqueKey":"lease.free_rent_amount","typeLabel":"integer"},"prepaid_rent_amount":{"description":"The amount of rent (in cents) paid in advance.","type":"integer","maximum":5000000,"minimum":0,"example":0,"uniqueKey":"lease.prepaid_rent_amount","typeLabel":"integer"},"start_date":{"oneOf":[{"description":"The date when this lease takes effect.","type":"string","format":"date","example":"2026-09-01","uniqueKey":"lease.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease takes effect.","type":"null","format":"date","example":"2026-09-01","uniqueKey":"lease.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.start_date","typeLabel":"string\u003cdate> | null"}},"isRequired":true,"uniqueKey":"lease","typeLabel":"object"},"object":{"type":"string","example":"invite","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"property_id":{"type":"string","example":"prop_01HQ7A","isRequired":true,"uniqueKey":"property_id","typeLabel":"string"},"status":{"type":"string","enum":["created","accepted","canceled","expired"],"example":"accepted","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"application_id":{"oneOf":[{"type":"string","example":"sd_01HQ8Z","uniqueKey":"application_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"sd_01HQ8Z","uniqueKey":"application_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"application_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Optional key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"object","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"description":"Optional key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"null","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"obligee":{"oneOf":[{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"string","example":"Rivermark Residential LLC","uniqueKey":"obligee.oneOf.0","typeLabel":"string"},{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"null","example":"Rivermark Residential LLC","uniqueKey":"obligee.oneOf.1","typeLabel":"null"}],"uniqueKey":"obligee","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"inv_8f3k2jd9slq02mxp","status":"created","property_id":"prop_nvlbcx2e5jk0fqsf","application_id":null,"obligee":"Acme Property Management LLC","lease":{"start_date":"2026-03-01","end_date":"2027-08-31","monthly_rent":160000,"prepaid_rent_amount":120000,"free_rent_amount":10000,"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/ivre_q7ghmgtaavp37krc","first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","metadata":{},"object":"invite_recipient"}],"metadata":{},"object":"invite"},"examples":{"Example":{"title":"Example","value":{"id":"inv_8f3k2jd9slq02mxp","status":"created","property_id":"prop_nvlbcx2e5jk0fqsf","application_id":null,"obligee":"Acme Property Management LLC","lease":{"start_date":"2026-03-01","end_date":"2027-08-31","monthly_rent":160000,"prepaid_rent_amount":120000,"free_rent_amount":10000,"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/ivre_q7ghmgtaavp37krc","first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","metadata":{},"object":"invite_recipient"}],"metadata":{},"object":"invite"}}},"exampleType":"examples"}},"exampleType":"examples"},"20432e82-a91f-43b1-a022-bb7acb12c3cb":{"description":"Bad Request\n\n| `error_code` | When |\n| --- | --- |\n| `invalid_request` | The body is not valid JSON, or a field has the wrong type |\n| `validation_error` | The request failed validation; see field_errors |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["invalid_request","validation_error"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"field_errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["required","invalid_format","invalid_value","out_of_range","invalid_length","invalid_date_range","unknown_field","null_not_allowed","unsupported_field_edit","ambiguous_edit","incomplete_edit","invalid"],"x-enum-comments":{"FieldCodeAmbiguousEdit":"The field conflicts with another field in the same request","FieldCodeIncompleteEdit":"The field requires another field in the same request","FieldCodeInvalid":"The value is invalid for any other reason","FieldCodeInvalidDateRange":"end_date is not after start_date","FieldCodeInvalidFormat":"The value is not in the expected format (email, phone, date, id)","FieldCodeInvalidLength":"The value is too short or too long","FieldCodeInvalidValue":"The value is not one of the allowed values","FieldCodeNullNotAllowed":"null is not accepted at this path","FieldCodeOutOfRange":"The number is outside the allowed range","FieldCodeRequired":"The field is missing or blank","FieldCodeUnknownField":"The field is not recognized","FieldCodeUnsupportedFieldEdit":"The field cannot be edited on this invite or recipient entry"},"x-enum-descriptions":["The field is missing or blank","The value is not in the expected format (email, phone, date, id)","The value is not one of the allowed values","The number is outside the allowed range","The value is too short or too long","end_date is not after start_date","The field is not recognized","null is not accepted at this path","The field cannot be edited on this invite or recipient entry","The field conflicts with another field in the same request","The field requires another field in the same request","The value is invalid for any other reason"],"x-enum-varnames":["FieldCodeRequired","FieldCodeInvalidFormat","FieldCodeInvalidValue","FieldCodeOutOfRange","FieldCodeInvalidLength","FieldCodeInvalidDateRange","FieldCodeUnknownField","FieldCodeNullNotAllowed","FieldCodeUnsupportedFieldEdit","FieldCodeAmbiguousEdit","FieldCodeIncompleteEdit","FieldCodeInvalid"],"uniqueKey":"field_errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"field":{"type":"string","example":"lease.start_date","uniqueKey":"field_errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"must be in YYYY-MM-DD format","uniqueKey":"field_errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"field_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"field_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"validation error: coverage_level: coverage_level must be one of low, medium, high.","error_code":"validation_error","field_errors":[{"field":"coverage_level","code":"invalid_value","message":"coverage_level must be one of low, medium, high"}],"object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"validation error: coverage_level: coverage_level must be one of low, medium, high.","error_code":"validation_error","field_errors":[{"field":"coverage_level","code":"invalid_value","message":"coverage_level must be one of low, medium, high"}],"object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"f98ca859-8dfa-467c-9f9f-44df01b6c4a6":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["message","object"],"properties":{"message":{"type":"string","example":"invite not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Missing authorization header","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"Missing authorization header","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"23ed4bd3-25e3-484d-81b2-71fd2118ef4b":{"description":"Forbidden\n\n| `error_code` | When |\n| --- | --- |\n| `invite_property_inactive` | The invite's own property is inactive |\n| `target_property_inactive` | The submitted property_id is inactive |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["invite_property_inactive","target_property_inactive"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"cannot move invite, the new property is inactive","error_code":"target_property_inactive","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"cannot move invite, the new property is inactive","error_code":"target_property_inactive","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"163fce83-3505-4594-a6cf-aa926f36d1f1":{"description":"Not Found\n\n| `error_code` | When |\n| --- | --- |\n| `invite_not_found` | The invite was not found |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["invite_not_found"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"invite not found","error_code":"invite_not_found","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"invite not found","error_code":"invite_not_found","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"bf9c1d7a-dbcd-4246-8ee5-11d7e125442b":{"description":"Conflict\n\n| `error_code` | When |\n| --- | --- |\n| `invite_accepted` | A recipient has already accepted the invite |\n| `invite_application_started` | The invite is in the process of being converted into an application |\n| `invite_canceled` | The invite has been canceled |\n| `invite_expired` | The invite has expired |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["invite_accepted","invite_application_started","invite_canceled","invite_expired"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"cannot amend invite, a recipient has already accepted it","error_code":"invite_accepted","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"cannot amend invite, a recipient has already accepted it","error_code":"invite_accepted","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"2de8668e-ffbf-4d5d-801c-0f76f220a364":{"description":"Unprocessable Entity\n\n| `error_code` | When |\n| --- | --- |\n| `property_not_found` | The property was not found |\n| `unit_not_found` | The unit was not found |\n| `unit_not_on_property` | The unit does not belong to the property |\n| `invalid_address` | The address failed validation |\n| `invalid_lease_date_range` | The lease end date isn't after the start date |\n| `locality_change_requires_property_id` | The city, state, or postal_code were changed without a new property_id |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["property_not_found","unit_not_found","unit_not_on_property","invalid_address","invalid_lease_date_range","locality_change_requires_property_id"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"property not found","error_code":"property_not_found","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"property not found","error_code":"property_not_found","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"f5007bbc-5bcb-4679-b202-2b9cf22ae9dd":{"description":"Rate limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"c66223cd-7efb-48e0-a749-5616ebe92a9c":{"description":"Internal Server Error\n\n| `error_code` | When |\n| --- | --- |\n| `internal_error` | An unexpected server error occurred |","content":{"application/json":{"schema":{"type":"object","required":["message","object","error_code"],"properties":{"error_code":{"type":"string","enum":["internal_error"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"unable to update invite","error_code":"internal_error","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"unable to update invite","error_code":"internal_error","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"37c68e76-2171-4724-95e9-80fff86fbc48":{"BasicAuth":{"type":"http","scheme":"basic","scopes":[],"schemeName":"BasicAuth"}}},"servers":{"4c923e28-1932-4d68-820c-f5aa1183a0de":{"url":"https://api.theguarantors.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/application-api.json"},"subdomain":"theguarantors-2e3c1083","siteName":"The Guarantors API","title":"Update an invite - The Guarantors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T17:59:59.368Z","originalFileLocation":"application-api/invites/update-an-invite.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn\u0026#x27;t been canceled, expired, or converted into an application. Changing only metadata doesn\u0026#x27;t send an invite.updated webhook.\">\u003cmeta data-mint-head name=\"application-name\" content=\"The Guarantors API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an invite - The Guarantors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn\u0026#x27;t been canceled, expired, or converted into an application. Changing only metadata doesn\u0026#x27;t send an invite.updated webhook.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"The Guarantors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.theguarantors.com/application-api/invites/update-an-invite\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Invites\u0026amp;title=Update+an+invite\u0026amp;description=Updates+the+property%2C+unit%2C+coverage+level%2C+lease+terms%2C+or+metadata+of+an+invite.+Only+fields+present+in+the+request+are+changed.+An+invite+can+be+amended+as+l\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=dc7108471b163adcaa5448fb6ae421ef09f617f9bb2f1cbdc9520979c68ef5f1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update an invite - The Guarantors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn\u0026#x27;t been canceled, expired, or converted into an application. Changing only metadata doesn\u0026#x27;t send an invite.updated webhook.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Invites\u0026amp;title=Update+an+invite\u0026amp;description=Updates+the+property%2C+unit%2C+coverage+level%2C+lease+terms%2C+or+metadata+of+an+invite.+Only+fields+present+in+the+request+are+changed.+An+invite+can+be+amended+as+l\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=dc7108471b163adcaa5448fb6ae421ef09f617f9bb2f1cbdc9520979c68ef5f1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"The Guarantors API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3DB157\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.theguarantors.com/application-api/invites/update-an-invite\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/application-api/invites/update-an-invite.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.theguarantors.com/#organization\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.theguarantors.com#website\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite#webpage\",\"url\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite\",\"name\":\"Update an invite\",\"description\":\"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application. Changing only metadata doesn't send an invite.updated webhook.\",\"dateModified\":\"2026-11-09T17:59:59.368Z\",\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application API\",\"item\":\"https://docs.theguarantors.com/application-api/invites/create-an-invite\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invites\",\"item\":\"https://docs.theguarantors.com/application-api/invites/create-an-invite\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update an invite\",\"item\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite#apireference\",\"headline\":\"Update an invite\",\"name\":\"Update an invite\",\"description\":\"Updates the property, unit, coverage level, lease terms, or metadata of an invite. Only fields present in the request are changed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application. Changing only metadata doesn't send an invite.updated webhook.\",\"url\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite\",\"mainEntityOfPage\":{\"@id\":\"https://docs.theguarantors.com/application-api/invites/update-an-invite#webpage\"},\"dateModified\":\"2026-11-09T17:59:59.368Z\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"}}]}\u003c/script>","siteName":"The Guarantors API","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Application API","pages":[{"group":"Invites","pages":[{"title":"Create an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites","href":"/application-api/invites/create-an-invite"},{"title":"Retrieve an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{id}","href":"/application-api/invites/retrieve-an-invite"},{"title":"List invites","description":"Returns a paginated list of invites belonging to the authenticated partner.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites","href":"/application-api/invites/list-invites"},{"title":"Update an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invites/{id}","href":"/application-api/invites/update-an-invite"},{"title":"Cancel an invite","description":"Cancels an invite that has not yet converted to an application. Returns 409 once conversion has started.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/cancel","href":"/application-api/invites/cancel-an-invite"},{"title":"invite.updated","version":null,"deprecated":null,"sidebarTitle":"invite.updated","openapi":"/openapi/application-api.json webhook invite.updated","href":"/application-api/invites/inviteupdated"},{"title":"invite.status.canceled","version":null,"deprecated":null,"sidebarTitle":"invite.status.canceled","openapi":"/openapi/application-api.json webhook invite.status.canceled","href":"/application-api/invites/invitestatuscanceled"}]},{"group":"Invite Recipients","pages":[{"title":"Add an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/invite-recipients","href":"/application-api/invites/add-an-invite-recipient"},{"title":"Update an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invite-recipients/{id}","href":"/application-api/invites/update-an-invite-recipient"},{"title":"Remove an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json delete /v1/invite-recipients/{id}","href":"/application-api/invites/remove-an-invite-recipient"},{"title":"invite_recipient.added","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.added","openapi":"/openapi/application-api.json webhook invite_recipient.added","href":"/application-api/invites/invite_recipientadded"},{"title":"invite_recipient.updated","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.updated","openapi":"/openapi/application-api.json webhook invite_recipient.updated","href":"/application-api/invites/invite_recipientupdated"},{"title":"invite_recipient.removed","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.removed","openapi":"/openapi/application-api.json webhook invite_recipient.removed","href":"/application-api/invites/invite_recipientremoved"}]},{"group":"Applications","pages":[{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{id}","href":"/application-api/applications/retrieve-an-application"},{"title":"Retrieve an application by invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{invite_id}/application","href":"/application-api/applications/retrieve-an-application-by-invite"},{"title":"Cancel an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/applications/{id}/cancel","href":"/application-api/applications/cancel-an-application"},{"title":"application.status.started","version":null,"deprecated":null,"sidebarTitle":"application.status.started","openapi":"/openapi/application-api.json webhook application.status.started","href":"/application-api/applications/applicationstatusstarted"},{"title":"application.status.submitted","version":null,"deprecated":null,"sidebarTitle":"application.status.submitted","openapi":"/openapi/application-api.json webhook application.status.submitted","href":"/application-api/applications/applicationstatussubmitted"},{"title":"application.status.pending","version":null,"deprecated":null,"sidebarTitle":"application.status.pending","openapi":"/openapi/application-api.json webhook application.status.pending","href":"/application-api/applications/applicationstatuspending"},{"title":"application.status.approved","version":null,"deprecated":null,"sidebarTitle":"application.status.approved","openapi":"/openapi/application-api.json webhook application.status.approved","href":"/application-api/applications/applicationstatusapproved"},{"title":"application.status.denied","version":null,"deprecated":null,"sidebarTitle":"application.status.denied","openapi":"/openapi/application-api.json webhook application.status.denied","href":"/application-api/applications/applicationstatusdenied"},{"title":"application.status.canceled","version":null,"deprecated":null,"sidebarTitle":"application.status.canceled","openapi":"/openapi/application-api.json webhook application.status.canceled","href":"/application-api/applications/applicationstatuscanceled"}]},{"group":"Applicants","pages":[{"title":"Retrieve an applicant","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applicants/{id}","href":"/application-api/applicants/retrieve-an-applicant"},{"title":"applicant.status.started","version":null,"deprecated":null,"sidebarTitle":"applicant.status.started","openapi":"/openapi/application-api.json webhook applicant.status.started","href":"/application-api/applicants/applicantstatusstarted"},{"title":"applicant.status.submitted","version":null,"deprecated":null,"sidebarTitle":"applicant.status.submitted","openapi":"/openapi/application-api.json webhook applicant.status.submitted","href":"/application-api/applicants/applicantstatussubmitted"}]},{"group":"Bonds","pages":[{"title":"Retrieve a bond","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/bonds/{id}","href":"/application-api/bonds/retrieve-a-bond"},{"title":"List bonds for an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{application_id}/bonds","href":"/application-api/bonds/list-bonds-for-an-application"},{"title":"bond.status.issued","version":null,"deprecated":null,"sidebarTitle":"bond.status.issued","openapi":"/openapi/application-api.json webhook bond.status.issued","href":"/application-api/bonds/bondstatusissued"},{"title":"bond.status.canceled","version":null,"deprecated":null,"sidebarTitle":"bond.status.canceled","openapi":"/openapi/application-api.json webhook bond.status.canceled","href":"/application-api/bonds/bondstatuscanceled"}]},{"group":"Webhooks","pages":[{"title":"Trigger a sandbox webhook","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/webhooks/trigger","href":"/application-api/webhooks/trigger-a-sandbox-webhook"}]}]},{"group":"Schemas","pages":[{"title":"Invite","href":"/schemas/invite"},{"title":"InviteRecipient","href":"/schemas/invite-recipient"},{"title":"Lease","href":"/schemas/lease"},{"title":"Address","href":"/schemas/address"},{"title":"Coverage","href":"/schemas/coverage"},{"title":"Application","href":"/schemas/application"},{"title":"Applicant","href":"/schemas/applicant"},{"title":"Bond","href":"/schemas/bond"},{"title":"Principal","href":"/schemas/principal"},{"title":"Error","href":"/schemas/error"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update an invite - The Guarantors API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C945cI-W.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}