Skip to main content
POST
/
v1
/
customers
Error
A valid request URL is required to generate request examples
{
  "id": "a3f1d7d0-ef1d-4b2e-aad2-123456789abc",
  "type": "individual",
  "email": "[email protected]",
  "phone": "+33612345678",
  "name": "John Doe",
  "companyName": "Doe Industries",
  "siren": "732829320",
  "tvaNumber": "FR12732829320",
  "address": "10 Rue de Paris, 75001 Paris, France"
}

Authorizations

​
Authorization
string
header
required

OAuth2 authentication for Boseat API

Body

application/json
​
type
enum<string>
required

Specifies whether the customer is an individual or a company

Available options:
individual,
company
Example:

"individual"

​
email
string
required

Email address of the customer

Example:

"[email protected]"

​
phone
string
required

Phone number of the customer

Example:

"+33612345678"

​
name
string

Full name of the customer (if individual)

Example:

"John Doe"

​
companyName
string

Company name (if customer is a company)

Example:

"Doe Industries"

​
siren
string

SIREN number of the company

Example:

"732829320"

​
tvaNumber
string

VAT number of the company

Example:

"FR12732829320"

​
address
string

Billing address of the customer

Example:

"10 Rue de Paris, 75001 Paris, France"

Response

Customer created or found successfully. Returns the customer details including the unique ID.

​
id
string<uuid>
required

Unique customer identifier (UUID)

Example:

"a3f1d7d0-ef1d-4b2e-aad2-123456789abc"

​
type
enum<string>
required

Specifies whether the customer is an individual or a company

Available options:
individual,
company
Example:

"individual"

​
email
string
required

Email address of the customer

Example:

"[email protected]"

​
phone
string
required

Phone number of the customer

Example:

"+33612345678"

​
name
string

Full name of the customer (if individual)

Example:

"John Doe"

​
companyName
string

Company name (if customer is a company)

Example:

"Doe Industries"

​
siren
string

SIREN number of the company

Example:

"732829320"

​
tvaNumber
string

VAT number of the company

Example:

"FR12732829320"

​
address
string

Billing address of the customer

Example:

"10 Rue de Paris, 75001 Paris, France"