Update guarantor

PATCH

/api/guarantors/v1/:guarantor_id

PATCH

/api/guarantors/v1/:guarantor_id

import requests
url = "https://api.taigabilling.com/api/guarantors/v1/guarantor_id"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

200Updated

{
  "address": {
    "address1": "string",
    "city": "string",
    "state": "AA",
    "zip_code": "string",
    "address2": "string",
    "zip_plus_four_code": "string"
  },
  "auto_charge_consent": true,
  "email_consent": true,
  "external_id": "string",
  "first_name": "string",
  "guarantor_id": "string",
  "last_name": "string",
  "phone_consent": true,
  "phone_numbers": [
    {
      "number": "1234567890",
      "type": "Home"
    }
  ],
  "date_of_birth": "2023-01-15",
  "email": "string"
}

Updates a guarantor by its guarantor_id.

Authentication

AuthorizationBearer

Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Path parameters

guarantor_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

first_namestring or nullOptional

last_namestring or nullOptional

external_idstring or nullOptional

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

date_of_birthdate or nullOptional

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

addressobject or nullOptional

phone_numberslist of objects or nullOptional

phone_consentboolean or nullOptional

emailstring or nullOptional

email_consentboolean or nullOptional

auto_charge_consentboolean or nullOptional

Response

addressobject

auto_charge_consentboolean

email_consentboolean

external_idstring

first_namestring

guarantor_idstringformat: "uuid"

last_namestring

phone_consentboolean

phone_numberslist of objects

date_of_birthdate or nullOptional

emailstring or nullOptional