POST/api/v1/clients/{id}/merge

Product availabilityAlgaPSAAlgaDesk

Merge a client into this one

Absorbs source_client_id into this client as a billing profile. The source's billing profiles are re-parented keeping their ids, so invoices, billing cycles, payment methods, credits and tax settings follow them; tickets, contacts, projects, assets, contracts, locations and portal visibility groups move to this client. The source client is archived with a forwarding marker. Irreversible. Requires client update and delete.

RBAC · client

Path parameters

idstring <uuid>Required

Request body

Content type: application/json · schema ClientMergeBody

source_client_idstring <uuid>Required

contact_assignmentsarray of object

itemsobject

contact_name_idstring <uuid>Required

billing_profile_idstring <uuid>Required

is_managerboolean

can_view_profile_ticketsboolean

contract_decisionsarray of object

itemsobject

client_contract_idstring <uuid>Required

choicestringRequired

Enum: originalcutover

cutover_datestringNullable

pin_portal_grantsboolean

Defaults to true: records the billing segments unrestricted portal users have today.

external_remap_choicesarray of object

itemsobject

mapping_idstringRequired

applybooleanRequired

Response body

Success response 200 · schema ClientMergeEnvelope

dataobjectRequired

merge_idstring <uuid>Required

source_client_idstring <uuid>Required

target_client_idstring <uuid>Required

moved_profile_idsarray of stringRequired

itemsstring <uuid>

moved_default_profile_idstring <uuid>RequiredNullable

countsobjectRequired

remapped_external_mapping_idsarray of stringRequired

itemsstring

skipped_external_mapping_idsarray of stringRequired

itemsstring

metaobject

Response codes

200

Merge completed.

400

Invalid payload, or the merge was refused (blockers are returned as validation details).

401

API key missing/invalid or key user not found.

403

Permission denied for client update or delete.

404

Client not found.

500

Unexpected merge failure.

POST /api/v1/clients/{id}/merge

cURL

curl -X POST "https://algapsa.com/api/v1/clients/{id}/merge" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "source_client_id": "01HN2K7VRB9PQ3Y0000000000",
  "contact_assignments": [
    {
      "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
      "billing_profile_id": "01HN2K7VRB9PQ3Y0000000000",
      "is_manager": false,
      "can_view_profile_tickets": false
    }
  ],
  "contract_decisions": [
    {
      "client_contract_id": "01HN2K7VRB9PQ3Y0000000000",
      "choice": "original",
      "cutover_date": "string"
    }
  ],
  "pin_portal_grants": false,
  "external_remap_choices": [
    {
      "mapping_id": "string",
      "apply": false
    }
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/{id}/merge", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "source_client_id": "01HN2K7VRB9PQ3Y0000000000",
    "contact_assignments": [
      {
        "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
        "billing_profile_id": "01HN2K7VRB9PQ3Y0000000000",
        "is_manager": false,
        "can_view_profile_tickets": false
      }
    ],
    "contract_decisions": [
      {
        "client_contract_id": "01HN2K7VRB9PQ3Y0000000000",
        "choice": "original",
        "cutover_date": "string"
      }
    ],
    "pin_portal_grants": false,
    "external_remap_choices": [
      {
        "mapping_id": "string",
        "apply": false
      }
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/clients/{id}/merge");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""source_client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""contact_assignments"": [
    {
      ""contact_name_id"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""billing_profile_id"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""is_manager"": false,
      ""can_view_profile_tickets"": false
    }
  ],
  ""contract_decisions"": [
    {
      ""client_contract_id"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""choice"": ""original"",
      ""cutover_date"": ""string""
    }
  ],
  ""pin_portal_grants"": false,
  ""external_remap_choices"": [
    {
      ""mapping_id"": ""string"",
      ""apply"": false
    }
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "merge_id": "01HN2K7VRB9PQ3Y0000000000",
    "source_client_id": "01HN2K7VRB9PQ3Y0000000000",
    "target_client_id": "01HN2K7VRB9PQ3Y0000000000",
    "moved_profile_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "moved_default_profile_id": "01HN2K7VRB9PQ3Y0000000000",
    "counts": {},
    "remapped_external_mapping_ids": [
      "string"
    ],
    "skipped_external_mapping_ids": [
      "string"
    ]
  },
  "meta": {}
}