Create User

post

https://platform.nector.io/api/v2/merchant/leads

Creates a new customer on nector against your business workspace. customerid is the mapping between your system and nector, store the returned lead id as well since most APIs accept either of the two. No x-leadtoken is needed, the write access api key is the authentication. This API can be called only with a write access api key, so call it only from your backend. DO NOT EXPOSE THE WRITE ACCESS API KEY IN A BROWSER OR APP

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customer_id

string

required

(Required) (Make sure this is not predictable value. ex any uuid value) (Minimum length is 8) (Maximum length is 128) (This is the mapping id between your system and nector, this value can be used to pull the details of the customer)

name

string

required

(Required) (This is full name of the user ex. John Wick) (Maximum length is 200)

referral_code

string

(Minimum length is 8) (Maximum length is 128) (Custom referral code to assign to this customer, lowercased and slugified) (When omitted a unique 10 character code is generated)

metadetail

object

required

(Required) (One of email or mobile must be passed inside metadetail)

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists