Partner residency applications

Update a draft partner residency application

Changed on

Replaces the application data of a Draft. Requires the latest version as expectedVersion. Any change to applicationData invalidates the current agreement acceptance and returns a fresh nextSteps.agreementUrl. Once the invoice is paid, residencyType and the applicant email are locked. Changing the applicant email sends a new claim email to the new address.

patch/api/v1/partner/residency_applications/{id}

Request

Path parameters

idstring uuid required
Example:4e368230-84e3-4cb8-9225-a6d972e425fc

Request body

expectedVersioninteger required
referralCodestring
redirectUrlstring uri

Response

Updated application.

Changes

    • breaking

      added the pattern ^\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*(?:(?: +|['\u2019\u02bc\u00b7-]|\. ?)\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*)*\.?$ to the request property //

    • breaking

      added the pattern ^\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*(?:(?: +|['\u2019\u02bc\u00b7-]|\. ?)\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*)*\.?$ to the request property //

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 100

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status