Add contact channel
well_add_contact_channelAdd a contact channel to a company or person.
Wraps the resource-scoped REST endpoints (POST /v1/{companies,people}/:id/{emails,phones,web-links,locations}).
channel + the matching value field:
email → value.email
phone → value.e164_number (E.164; a leading "+" is added if missing)
web_link → value.url (+ optional value.platform, default "website")
location → value.city, value.country (+ optional address_line1/2, region, postal_code) value.label is optional (defaults to "work").
For a company address read from a public company registry hit (well_search_company_registry), pass the hit's id as registry_ref: the address is stored with "registry" as its source. The call is refused, with nothing written, when that hit is not from an official registry, is for another registry number or country than the company's, or does not carry every address part given.
On an invoice draft, pass draft_party with the draft's invoice_id: "receiver" says the parent is the draft's customer (its company or its person), "issuer" says the parent is the company that issues it. The call is refused, with nothing written, when the parent is not that party. While the conversation has an open draft, a call whose parent is the workspace's own company and that has no draft_party is refused before any confirmation: a detail the person gives on a draft is the customer's unless they say it is their own company's, and when their words do not say which, ask them in one line first. Otherwise, without draft_party, the parent is checked only to be a live record of the workspace.
NOTE: adding a phone is supported on a PERSON but NOT on a company (no endpoint) — that combination returns a clear error. To READ existing channels, use well_query_records on the parent (companies/people) or the channel root.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| value | Yes | Channel value — fill the field(s) for the chosen channel | |
| parent | Yes | Parent record type: company or person | |
| channel | Yes | Channel to add: email | phone | web_link | location | |
| parent_id | Yes | UUID of the parent company or person | |
| draft_party | No | Set on an invoice draft: the call is refused unless the parent is this party of the draft | |
| registry_ref | No | Company location only: the id of the registry hit the address was read from | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| parent | No | ||
| channel | No | ||
| success | Yes | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |