Skip to main content
POST
/
platform-customers
cURL
curl --request POST \
  --url https://ebrcapi.dev.eximfiles.com/api/v1/platform-customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "[email protected]",
  "type": "customer",
  "companyName": "<string>",
  "address": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email": "[email protected]",
  "type": "customer",
  "companyName": "<string>",
  "address": "<string>",
  "platformId": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
​
email
string<email>
required
​
type
enum<string>
default:customer
required
Available options:
customer
​
companyName
string
​
address
string

Response

Customer created

​
id
string

Unique identifier of the platform customer

​
name
string
​
email
string<email>
​
type
enum<string>
default:customer
Available options:
customer
​
companyName
string
​
address
string
​
platformId
string

Platform user ID that owns this customer

​
isActive
boolean
​
createdAt
string<date-time>
​
updatedAt
string<date-time>