Créer un propriétaire

POST

/v1/owners

curl --request POST \
  --url https://example.com/v1/owners \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "code": "example", "name": "example", "ownerType": "individual", "vatRegime": "non_subject", "siret": "example", "vatNumber": "example", "address": "example", "email": "hello@example.com", "phone": "example" }'

Authorizations

• ApiKeyAuth
• BearerAuth

Request Body ^required

Media type application/json

object

code

required

string

<= 20 characters

name

required

string

<= 200 characters

ownerType

required

string

Allowed values: individual company

vatRegime

required

string

Allowed values: non_subject exempt subject_10 subject_20

siret

14 chiffres

string

nullable

vatNumber

string

nullable

address

string

nullable

email

string format: email

nullable

phone

string

nullable

Responses

201

Propriétaire créé

Media type application/json

object

data

required

object

id

required

string format: uuid

Example ^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Corps invalide

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée (owner.manage)

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}