Skip to main content
A Contact is a saved recipient in your Detrack address book: the same list you see on the Contacts page in the dashboard. Each contact keeps a recipient’s name, company, address, and contact details, plus the groups they belong to and any items you usually send them.

​
Fields

A contact uses the same field names as a job, so you can copy values between the two.
  • deliver_to_collect_from (string) — Recipient’s name. A contact needs this or company_name.
  • company_name (string) — Company name. A contact needs this or deliver_to_collect_from.
  • address (string) — Full address. Required unless you send address_1, address_2, or address_3.
  • address_1, address_2, address_3, postal_code, city, state, country (string) — Optional address parts.
  • phone_number, notify_email, instructions, remarks (string) — Optional contact details and notes.
  • groups (array) — Groups the contact belongs to, each with an id and a name.
  • items (array) — Items you usually send this recipient, each with sku, description, and quantity.
  • id (string, read-only) — Detrack’s internal contact ID. Use it to retrieve, update, or delete the contact.
Every field is always returned, and empty fields are null. The pick-up fields (pick_up_*) are returned only if your account uses point-to-point jobs. See Retrieve a contact for the full list.

​
Addresses

Send the full address in address, or send the parts in address_1 to address_3. When you create a contact, Detrack adds any address_1 to address_3, city, state, and postal_code you send to the end of address, even if you send no address lines. An address made of nothing but those same parts isn’t repeated, but anything else in it is kept, so the same detail can appear twice. Send the full address or the parts, not both.

​
Which contacts you can see

An API key acts as the dashboard user it belongs to. If that user only has access to some groups, the API returns only the contacts in those groups, unless your account lets everyone view all contacts. A contact that user creates must be in at least one of their groups.

​
Searching

List contacts takes a q parameter that matches the recipient’s name, last name, or company name. Use it to find a contact’s id before you update or delete it.