Remove a co-applicant
Removes a co-applicant from the group on this application. Requires the rental_applications:write permission.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Path parameters
applicationIdstringrequiredThe rental application to work with. A Snowflake id, sent as a decimal string.
example: 1830472847398404096
coApplicantIdstringrequiredThe co-applicant's own rental application, taken from coApplicants[].id on the application. A Snowflake id, sent as a decimal string.
example: 1830472901847362560
Response
200 · The co-applicant was removed. The response has no body.
401 · The access token is missing, expired, or not valid.
403 · The caller is authenticated but does not hold the `rental_applications:write` permission.
404 · No co-applicant with this id exists on this rental application, or the rental application itself was not found.
Allowed in every application status
This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.