Contacts

A contact is a person, trust or organization your firm works with, usually a member of a household. The console shows contacts on the Contacts tab of the Clients page. A contact can be linked to a record in your firm's CRM; see Contact data connections.

The contact tags of your firm's CRMs are operations of this tag.

📄️List contact tags

Returns, in order of name, the contact tags of each CRM your firm is connected to: Wealthbox, Redtail and Slant. A name that more than one CRM uses is listed once, with the ID of the first of Wealthbox, Redtail and Slant that has it. If a CRM does not answer, its tags are left out of the response.

📄️List contacts

Returns your firm's active contacts, in order of contact ID. Each contact has the details its linked CRM record holds, such as its contact information and tags, and the ID and name of its household. For a contact in a household, only the CRM the household is linked to is read. `slantBookId` and `slantHouseholdId` are always `null` here; **Get a contact** returns them.

📄️Create a contact

Creates a contact, and returns it as **Get a contact** returns it. For a person, send `type` as `person`, with `givenName` and `familyName`. For a trust or an organization, send `type` as `trust` or `organization`, without them. The contact is also created in Wealthbox and in Redtail when your firm is connected to that CRM, and is linked to each record created. It is not created in Slant. The contact is in no household.

📄️Get a contact

Returns the contact with the given ID, archived or not, with the details its linked CRM record holds, such as its contact information and tags, and the ID and name of its household. For a contact in a household, only the CRM the household is linked to is read. For a Slant person in a household, `slantBookId` and `slantHouseholdId` give its Slant book and household. If your firm has no contact with that ID, the response is `404`.

📄️Update a contact

Updates the fields you send of the contact with the given ID, and returns the contact. Fields you leave out keep their current values. The changes are also written to the contact's linked CRM records: for a contact in a household, only to the record in the CRM the household is linked to. If your firm has no contact with that ID, the response is `404`.

📄️Archive a contact

Archives the contact with the given ID, and returns the contact as **Get a contact** returns it. `archiveDate` is the time of the request. The contact's Wealthbox record is also made inactive; its Redtail record keeps its status. `isActive` is `false`, or the status of the contact's CRM record when it is linked to one. If your firm has no contact with that ID, the response is `404`.

📄️Unarchive a contact

Makes the contact with the given ID active again, and returns the contact as **Get a contact** returns it. `archiveDate` is `null`. The contact's Wealthbox record is also made active; its Redtail record keeps its status. `isActive` is `true`, or the status of the contact's CRM record when it is linked to one. If your firm has no contact with that ID, the response is `404`.

📄️Create a note for a contact

Creates a note with the text in `content` on the contact's Wealthbox and Redtail records. The contact's Slant record gets no note. The response is the Wealthbox note, or the Redtail note when no Wealthbox note was created, or `data: null` when no note was created, for example when the contact is linked to neither Wealthbox nor Redtail. Link the contact to a CRM record first; see **Update contact data connections**. If your firm has no contact with that ID, nothing is created and the response is `404`.

📄️Create a task for a contact

Creates a task for the contact with the given ID in its linked CRM records: for a contact in a household, only in the CRM the household is linked to; otherwise in each of Wealthbox, Redtail and Slant the contact is linked to. The response is the task as the CRMs return it; where more than one CRM gives a field, the value is the last of Wealthbox, Redtail and Slant. The response is `201` with `data: null` when no CRM created a task, for example when the contact is linked to no CRM. Wealthbox takes the priority `Urgent` as `High`. If your firm has no contact with that ID, nothing is created and the response is `404`.

📄️Create a workflow for a contact

Creates a workflow for the contact with the given ID from a workflow template of its linked CRM: an integer `template` in Wealthbox, a string `template` in Redtail. A CRM whose template is of the other form is skipped. With a Redtail template, send `category`. The response is `201` with `data: null` when no workflow was created, for example when the contact is linked to neither Wealthbox nor Redtail. If your firm has no contact with that ID, nothing is created and the response is `404`.