v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Customers

Bulk update providers/customers mapping

Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.

post/v1/customers/providers-bulk-update

Query parameters

boolean
OR
'true' | 'false'

Sync the customer with the provider after updating the mapping. If the provider is a Payment Service Provider, the payment methods of the customers will be imported.

Request body

customer_idstring required

Customer ID.

provider_name'mollie' | 'stripe' | 'gocardless' | 'airwallex' | 'hubspot' | 'attio' | 'salesforce' | 'xero' | 'exact-online' | 'pennylane' | 'quickbooks' | 'netsuite' | 'anrok' required

Provider name.

provider_idstring

Provider ID. Required if multiple instances of the same provider are connected in Hyperline.

provider_account_idstring nullable required

ID of the customer on the provider side. Using a null value will reset the previously saved ID.

Example request

[
  {
    "customer_id": "cus_Typ0px2W0aiEtl"
  }
]

Response

successfulnumber required

Number of record successfully updated.

expectednumber required

Number of record expected to be updated.

updatedstring[] required

Customer IDs that were successfully updated.