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

Product availabilityAlgaPSAAlgaDesk

Preview a client merge

Dry run of absorbing source_client_id into this client as a billing profile. Writes nothing; returns the profiles that would move, per-entity row counts, the contacts and contracts needing a decision, the portal users whose billing-segment access would widen, the accounting mappings that would need re-pointing, and any blockers.

RBAC · client

Path parameters

idstring <uuid>Required

Request body

Content type: application/json · schema ClientMergePreviewBody

source_client_idstring <uuid>Required

The client that would be absorbed.

Response body

Success response 200 · schema ClientMergePreviewEnvelope

dataobjectRequired

sourceClientIdstring <uuid>Required

sourceClientNamestringRequired

targetClientIdstring <uuid>Required

targetClientNamestringRequired

blockersarray of objectRequired

Non-empty means the merge would be refused.

itemsobject

codestringRequired

messagestringRequired

i18nKeystringRequired

profilesarray of objectRequired

itemsobject

billingProfileIdstring <uuid>Required

currentNamestringRequired

mergedNamestringRequired

The name the profile takes on the destination client.

isDefaultbooleanRequired

isActivebooleanRequired

movedDefaultProfileIdstring <uuid>RequiredNullable

countsobjectRequired

Rows that would move, by entity label.

contactsarray of objectRequired

itemsobject

contactNameIdstring <uuid>Required

fullNamestringRequired

emailstringRequiredNullable

suggestedBillingProfileIdstring <uuid>RequiredNullable

contractsarray of objectRequired

itemsobject

clientContractIdstring <uuid>Required

contractNamestringRequiredNullable

startDatestringRequired

endDatestringRequiredNullable

billingProfileIdstring <uuid>RequiredNullable

isActivebooleanRequired

suggestedChoicestringRequired

Enum: originalcutover

suggestedCutoverDatestringRequired

visibilityGroupRenamesarray of objectRequired

itemsobject

groupIdstring <uuid>Required

fromstringRequired

tostringRequired

unrestrictedPortalUserIdsarray of stringRequired

Portal users of the source that currently see every billing profile.

itemsstring <uuid>

externalMappingsarray of objectRequired

itemsobject

mappingIdstringRequired

integrationTypestringRequired

algaEntityTypestringRequired

externalEntityIdstringRequired

externalRealmIdstringRequiredNullable

targetAlreadyMappedbooleanRequired

metaobject

Response codes

200

Merge preview returned.

400

Invalid client id or request payload.

401

API key missing/invalid or key user not found.

403

Permission denied for client update.

404

Client not found.

500

Unexpected merge preview failure.

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

cURL

curl -X POST "https://algapsa.com/api/v1/clients/{id}/merge/preview" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "source_client_id": "01HN2K7VRB9PQ3Y0000000000"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/{id}/merge/preview", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "source_client_id": "01HN2K7VRB9PQ3Y0000000000"
  })
});
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/preview");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""source_client_id"": ""01HN2K7VRB9PQ3Y0000000000""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "sourceClientId": "01HN2K7VRB9PQ3Y0000000000",
    "sourceClientName": "string",
    "targetClientId": "01HN2K7VRB9PQ3Y0000000000",
    "targetClientName": "string",
    "blockers": [
      {
        "code": "string",
        "message": "string",
        "i18nKey": "string"
      }
    ],
    "profiles": [
      {
        "billingProfileId": "01HN2K7VRB9PQ3Y0000000000",
        "currentName": "string",
        "mergedName": "string",
        "isDefault": false,
        "isActive": false
      }
    ],
    "movedDefaultProfileId": "01HN2K7VRB9PQ3Y0000000000",
    "counts": {},
    "contacts": [
      {
        "contactNameId": "01HN2K7VRB9PQ3Y0000000000",
        "fullName": "string",
        "email": "string",
        "suggestedBillingProfileId": "01HN2K7VRB9PQ3Y0000000000"
      }
    ],
    "contracts": [
      {
        "clientContractId": "01HN2K7VRB9PQ3Y0000000000",
        "contractName": "string",
        "startDate": "string",
        "endDate": "string",
        "billingProfileId": "01HN2K7VRB9PQ3Y0000000000",
        "isActive": false,
        "suggestedChoice": "original",
        "suggestedCutoverDate": "string"
      }
    ],
    "visibilityGroupRenames": [
      {
        "groupId": "01HN2K7VRB9PQ3Y0000000000",
        "from": "string",
        "to": "string"
      }
    ],
    "unrestrictedPortalUserIds": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "externalMappings": [
      {
        "mappingId": "string",
        "integrationType": "string",
        "algaEntityType": "string",
        "externalEntityId": "string",
        "externalRealmId": "string",
        "targetAlreadyMapped": false
      }
    ]
  },
  "meta": {}
}