Skip to content

Organization methods: merge

The Organization Verbs merge as typed SDK methods, with inputs, result, refusals and an example.

Reference for Organization, one group of Organization methods.

Organization.merge

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

TypeScript
interface OrganizationVerbs {
  merge(input: OrganizationMergeInput, options?: SB.CallOptions): SB.Call<Organization>
}

Emits Organization.merged.

Inputs

InputTypeRequiredDescription
organizationOrganizationrequiredThe duplicate.
intoOrganizationrequiredThe Organization that remains.

Returns

OutputTypeRequiredDescription
organizationOrganizationrequiredThe remaining Organization.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

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