Skip to main content
POST
/
partner
/
customers
Create a customer
curl --request POST \
  --url https://api.prod.commenda.io/api/v1/partner/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "founder@example.com",
  "name": "Acme Holdings"
}
'
{
  "customerId": 77
}
Create a customer record that scopes later Partner API calls. Save the returned customerId. Use it when creating incorporations and when managing reusable Commenda OS resources such as key persons, business entities, and documents. 
curl --request POST \
  --url 'https://api.prod.commenda.io/api/v1/partner/customers' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
    "email": "founder@example.com",
    "name": "Acme Holdings"
  }'

{
  "customerId": 77
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
email
string<email>
required

Email address for the customer owner.

Example:

"founder@example.com"

​
name
string

Optional display name for the customer record.

Example:

"Acme Holdings"

Response

Customer created successfully

​
customerId
integer
required

Commenda customer identifier.

Example:

77