JOjoincandidhealth
v1

Create guarantor

Changed on

Creates a new guarantor and returns the newly created Guarantor object.

post/api/guarantors/v1/{encounter_id}

Request

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

Path parameters

encounter_idstring uuid required

Request body

first_namestring required
last_namestring required
external_idstring required
date_of_birthstring date
phone_consentboolean

Defaults to false

emailstring
email_consentboolean

Defaults to false

auto_charge_consentboolean

Defaults to false

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

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • 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

    • breaking

      the response's property 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 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

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id create removed and replaced with v1_create_15