JOjoincandidhealth
v1

Update guarantor

Changed on

Updates a guarantor by its guarantor_id.

patch/api/guarantors/v1/{guarantor_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/guarantors/v1/{guarantor_id}
  • Auth
    HTTP bearer

Path parameters

guarantor_idstring uuid required

Request body

first_namestring
last_namestring
external_idstring

A unique identifier for the guarantor assigned by an external system.

date_of_birthstring date

Date formatted as YYYY-MM-DD; eg: 2019-08-25.

phone_consentboolean
emailstring
email_consentboolean
auto_charge_consentboolean

Response

Response with status 200

first_namestring required
last_namestring required
external_idstring required
date_of_birthstring date
guarantor_idstring uuid required
phone_consentboolean required
emailstring
email_consentboolean required
auto_charge_consentboolean required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      for the path request parameter guarantor_id, the type was generalized from no type to string, and format from no format to uuid

    • 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 required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id update removed and replaced with v1_update_14