Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
DIR References

Update a DIR reference

Partially update one reference, addressed by the DIR id plus the reference's type (business or financial) and slot.

Cosmetic fields (full name, job title, organization, relationship, email) are always editable. The phone number and timezone may only be changed while a scheduled call has not yet been dialed; if a call is in progress or all attempts are complete, those fields are locked. Changing the timezone reschedules any pending call into the new local calling window.

patch/dir/{dir_id}/references/{ref_type}/{slot}

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

ref_type'business' | 'financial' required
Example:business

Reference type to address.

slotinteger required
Example:1

Reference slot, counting from 1. Business references are slots 1 and 2, matching the order they were sent in the business_references array; the financial reference is slot 1. Every reference returned by the submit and list endpoints carries its own ref_type and slot, so you do not need to derive them.

Request body

emailstring email

Reference contact email address.

full_namestring

Full name of the reference contact.

job_titlestring nullable

Job title of the reference contact.

organizationstring nullable

Organization the reference contact belongs to.

phone_e164string

Reference phone number in E.164 format.

relationship_to_registrantstring nullable

How the reference contact is related to the registering business.

timezonestring

IANA timezone id for the reference.

Example request

{
  "email": "dana.reyes@example.com",
  "full_name": "Dana Reyes",
  "job_title": "VP of Operations",
  "organization": "Acme Logistics",
  "phone_e164": "+14155550123",
  "relationship_to_registrant": "Supplier",
  "timezone": "America/New_York"
}

Response

The updated reference.

Example response

{
  "data": {
    "email": "dana.reyes@example.com",
    "full_name": "Dana Reyes",
    "job_title": "VP of Operations",
    "organization": "Acme Logistics",
    "phone_e164": "+14155550123",
    "record_type": "dir_reference",
    "ref_type": "business",
    "relationship_to_registrant": "Supplier",
    "slot": 1,
    "timezone": "America/New_York"
  }
}