unmergeIdentities

  • Web Services
  • UMPI
  • API Documentation

The unmergeIdentities web service is used to re-activate a previously-merged source record and force it apart from its current LinkID.

Note
This service can only be used to reverse the outcome of a mergeIdentities operation.

The unmergeIdentities operation re-activates a previously-merged source record that had been retired with the mergeIdentities web service. The service will only succeed if the web service request specifies a source record to re-activate that is already in a retired/merged state.

After the operation, the re-activated source record becomes active, visible, and update-able again, and the re-activated source record is also split apart from its current LinkID and put into a new LinkID by itself (since the unmerge operation is typically only used when the original merge was done in error).

When the unmergeIdentities operation is complete, the Universal MPI instance retains a history of the ‘do not merge’ assertion and continues to prevent the two source records from ever linking again even if they receive data updates in the future that make them appear to be the same identity.

The ‘do not merge’ assertion would only be removed and ignored if a subsequent linkIdentities or mergeIdentities web service call were made to force the source records back together.

unmergeIdentities JSON request

  • The request includes:

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The Source+Native ID of the active customer record from which the retired/merged source record is being unmerged
    • The Source+Native ID of the retired/merged customer record that should be re-activated and split out into its own new LinkID
  • {
      "trackingId": "string", 
      "content": {
        "unmergeFromSource": { 
          "name": "string",
          "id": "string"
        },
        "unmergeSource": {
          "name": "string",
          "id": "string"
        }
      }
    }
    

unmergeIdentities JSON response

  • The response includes:

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service (see section 3.1 above for more information)
    • The LinkID of the existing active Universal MPI entity, which was referred to as the “Unmerge From” identity in the request (as well as the list of Source+Native ID values that are associated with this LinkID)
    • The “Unmerged” LinkID that represents the new entity created to store the Source+Native ID that was re-activated.
  • {
      "trackingId": "string", 
      "auditId": UUID, 
      "success": true, 
      "retryableError": true, 
      "message": "string", 
      "errors": [
        "string"
      ],
      "content": { 
        "unmergedId": "string", 
        "unmergedSource": {
          "name": "string",
          "id": "string"
        },
        "unmergedFromId": "string", 
        "unmergedFromSource": {
          "name": "string",
          "id": "string"
        }
      }
    }