Help CenterHelp Center / Developers · Reference
Create a customer from your own system, update the ones it created, and know which accounts it cannot touch.
POST /api/webhook/user-create adds a customer to your shop, or updates one that your system created earlier. It needs User webhook on. See the Webhooks/Pushers tab.
| Field | Required | Meaning |
|---|---|---|
name | Yes | Customer name, up to 255 characters |
phone | Yes | Phone number, up to 20 characters |
external_id | No | Your system's customer id. Send it every time: it is the only way a customer is found for an update |
email | No | E-mail address |
password | No | Sign-in password for the customer, 6 characters or more. Applied on an update, not when the customer is first created |
address | No | Street address. The address fields below are saved only when this is sent |
house, landmark, place_name | No | Flat or house number, landmark, area name |
latitude, longitude | No | Map position, as strings |
tag | No | Accepted, up to 100 characters. This call does not store it |
is_active | No | Accepted as true or false. This call does not store it |
| Situation | Result |
|---|---|
No account has this external_id, e-mail or phone | A customer is created and linked to your shop. Answer: "User created successfully" |
The external_id belongs to a customer of your shop only, with no staff role | That customer is updated. Answer: "User updated successfully" |
No external_id match, but the e-mail or phone belongs to any existing account | Refused with HTTP 409, "This customer cannot be synced". This includes customers this API created earlier |
| The match is a staff, owner, rider or admin account | Refused with HTTP 409, "This customer cannot be synced" |
Customer accounts are shared across shops on the platform. A person who signed up themselves, or who also buys from another shop, cannot be changed or linked from your system.
The tab's own text says a customer is also updated when the phone number is already known. The code refuses that case.
name and external_id are replaced when sent.email and phone change only if no other account uses the new value. Changing either signs the customer out everywhere.password sets a new password. To give a new customer a password, send the call again with the same external_id.| Status | Message | Meaning |
|---|---|---|
| 200 | "User created successfully" or "User updated successfully" | data holds the customer |
| 401 | "Authentication failed" | Wrong or missing token |
| 401 | "User webhook is not enabled for this shop" | Turn on User webhook and save |
| 409 | "This customer cannot be synced" | See the table above |
| 422 | "Validation failed" | data lists one message per field |
To put the customer on a price list, see vendor types. That call finds the customer by the same external_id.