Skip to content

by Startups.Studio

Contact.merge

POST /{namespace}/contacts/{contact}/merge

Merge joins a duplicate Contact into another, keeping every link, Message and Event on the one that remains.

Noun: Contact
Mode: do
Event: Contact.merged

You, to your agent

Merge the contact Lena Fischer.

curl -X POST https://api.sb/petpantry.shop/contacts/contact_1/merge \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"into":"contact_1"}'

import { $ } from 'startup-builder'

const contact = await $.Contact.merge({ contact: 'contact_1', into: 'contact_1' })

npx startup-builder do Contact.merge --json '{"contact":"contact_1","into":"contact_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.merge({ contact: 'contact_1', into: 'contact_1' })"
  }
}

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The duplicate.
`into`	Contact	required	The Contact that remains.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The remaining Contact.

Effects

Emits Contact.merged.
Performed by the Sales Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Keeps the merged id as an alias; nothing is deleted.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Contact.merge

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Contact.list

Previous Page

Contact.subscribe

Next Page