INinvoiceninja
clients

Merge client

Changed on

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

Handles merging 2 clients

The id parameter is the client that will be the primary client after the merge has completed.

The mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client.

🚨 Important
This action requires elevated permissions, please note the X-API-PASSWORD header requirements for this route.

post/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge

Request

Path parameters

idstring string required

The Client Hashed ID

mergeable_client_hashed_idstring string required

The Mergeable Client Hashed ID

Query parameters

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
includestring

Include child relationships of the Client Object. ie ?include=documents,system_logs

Available includes:

contacts [All contacts related to the client]
documents [All documents related to the client]
gateway_tokens [All payment tokens related to the client]
activities [All activities related to the client]
ledger [The client ledger]
system_logs [System logs related to the client]
group_settings [The group settings object the client is assigned to]

Usage:

/api/v1/clients?include=contacts,documents,activities

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

X-API-PASSWORDstring required
Example:supersecretpassword

The login password when challenged on certain protected routes

Response

Returns the client object

Changes

  • 7cd7362d9d9fRevision changes
    • info

      added the new optional query request parameter index

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status