Skip to content

by Startups.Studio

OverviewOrganization

Organization.merge

POST /{namespace}/organizations/{organization}/merge

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

Noun: Organization
Mode: do
Event: Organization.merged

You, to your agent

Merge my organization.

curl -X POST https://api.sb/patentpad.com/organizations/organization_1/merge \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"into":"organization_1"}'

import { $ } from 'startup-builder'

const organization = await $.Organization.merge({ organization: 'organization_1', into: 'organization_1' })

npx startup-builder do Organization.merge --json '{"organization":"organization_1","into":"organization_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Organization.merge({ organization: 'organization_1', into: 'organization_1' })"
  }
}

Inputs

Input	Type	Required	Description
`organization`	Organization	required	The duplicate.
`into`	Organization	required	The Organization that remains.

Outputs

Output	Type	Required	Description
`organization`	Organization	required	The remaining Organization.

Effects

Emits Organization.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.	Organization.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`.