Documentation
Difficulty level:
API - Hook - POST hook/customer/
Incoming hook to create or update customer
POST hook/customer/
Used for
Incoming hook to create or update customer.
Authentication
Administrator access
Parameters
The table here only shows a view of the core variables. A full overview of variables can be found here.
Parameter | Description | Mandatory | Location | Example |
---|---|---|---|---|
cust_id | Customer ID | No | Body | |
If supplied, the application will try to find the corresponding customer | No | Body | ||
external_id | If supplied, the application will try to find the corresponding customer | No | Body |
Example
Create or update customer.
POST api/rest/hook/customer/
Request { "email": "info@teqa.nl", "external_id": "3114hqq4rqsvlhgr8s66msvju9" }
Response: { "customer_id": "10295", "sex": "Unknown", "initials": "", "lastname": "", "email": "info@teqa.nl", "tel_mob": "", "address1": "", "housenum": "", "postal": "", "city": "", "id": "10295" }
Customer fields are described here.