Related contacts

6 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Add related contact

related_contacts.addwriteconfirm

Put a contact on a custom-object record or a deal with an optional role, so the record or deal also shows on that contact's page and in filters by that contact. Adding someone already on it just changes their role. A new person queues the related_contact_added automation trigger for that contact, and enabled workflows may then send them messages or incur provider charges according to their configured steps.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Also answers to link a contact to a deal, add a contact to a case, associate contact, add heir, add co-owner.

Parameters

Field	Type	Required	Description
record_id	string (uuid)	optional	A custom-object record (custom_objects.list_records). Pass this OR deal_id, not both.
deal_id	string (uuid)	optional	A deal (deals.list). Pass this OR record_id, not both.
contact_id	string (uuid)	required	The contact to add (contacts.list). Must be in this account.
role	string	optional	What this person is to the record or deal, in your own words — e.g. "Heir", "Spouse", "Executor (Will)", "Decision maker". Up to 80 characters; blank means no role.

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.add \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool related_contacts_add at https://app.chirply.io/api/mcp, same bearer token, same input.

Records and deals for a contact

related_contacts.for_contactread

Everything one contact is on: each custom-object record and deal where they are the primary contact, a related contact (with their role), or picked in a "Link to a contact" field — with each record's name, type and link. Read-only; lists up to 100 of each, primary links first.

Also answers to what is this contact related to, contact's cases, contact's deals.

Parameters

Field	Type	Required	Description
contact_id	string (uuid)	required	The contact whose records and deals to list.

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.for_contact \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool related_contacts_for_contact at https://app.chirply.io/api/mcp, same bearer token, same input.

Related contacts

related_contacts.listread

List everyone on one custom-object record or one deal: its primary contact first, then each related contact with their role (e.g. joint owners, heirs, a spouse and an estate administrator on one case). Also returns the role names this account already uses, as suggestions. Read-only.

Also answers to contact roles, associated contacts, people on this deal, stakeholders.

Parameters

Field	Type	Required	Description
record_id	string (uuid)	optional	A custom-object record (custom_objects.list_records). Pass this OR deal_id, not both.
deal_id	string (uuid)	optional	A deal (deals.list). Pass this OR record_id, not both.

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "record_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "deal_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool related_contacts_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove related contact

related_contacts.removewriteconfirm

Take one related contact off a record or deal. The contact and the record or deal themselves are untouched; the record simply stops showing on that person's page. Queues the related_contact_removed automation trigger for that contact, and enabled workflows may then send them messages or incur provider charges according to their configured steps. A record's or deal's primary contact is changed by editing the record or deal, not here.

Also answers to unlink a contact from a deal, remove a contact from a case.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The related-contact link id (`link_id` from related_contacts.list).

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.remove \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool related_contacts_remove at https://app.chirply.io/api/mcp, same bearer token, same input.

Role suggestions

related_contacts.rolesread

The role names to suggest when adding a related contact, before any record or deal exists (the New deal and New case forms use this): the roles this account has already used, most used first, then a few generic ones it has not. Read-only.

Also answers to related contact roles, which roles do we use, role list.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.roles \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool related_contacts_roles at https://app.chirply.io/api/mcp, same bearer token, same input.

Change role

related_contacts.updatewrite

Change the role of one related contact on a record or deal (e.g. from "Heir" to "Executor (Will)"), or clear it. The person stays on the record; nothing is sent and no automation trigger fires.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The related-contact link id (`link_id` from related_contacts.list).
role	string (or null)	required	The new role, up to 80 characters. null or an empty string clears it.

Example

curl -X POST https://app.chirply.io/api/v1/actions/related_contacts.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "role": "example"
  }'

Test with your API key

Over MCP the same operation is the tool related_contacts_update at https://app.chirply.io/api/mcp, same bearer token, same input.