Upsert Customer

Create or update a customer. If id is provided, updates by id. Otherwise, if externalId is provided, finds by externalId and updates or creates if not found. If neither is provided, creates a new customer.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Request Body

application/json

id?string

The internal ID of the customer to update. If provided, updates by id.

name*string

The name of the customer

externalId?|

The external ID of the customer. If provided without id, finds by externalId and updates or creates if not found.

vatNumber?|

The VAT number of the customer

enterpriseNumber?|

The enterprise number of the customer

peppolAddresses?array<>

The Peppol addresses of the customer

Default[]

address*string

The street address of the customer

city*string

The city of the customer

postalCode*string

The postal code of the customer

country*string

The country code (ISO 3166-1 alpha-2) of the customer

email?|

The email address of the customer

phone?|

The phone number of the customer

Response Body

`application/json`

curl -X POST "https://app.recommand.eu/api/v1/customers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "address": "string",    "city": "string",    "postalCode": "string",    "country": "BE"  }'

{
  "success": true,
  "customer": {
    "id": "string",
    "teamId": "string",
    "externalId": "string",
    "name": "string",
    "vatNumber": "string",
    "enterpriseNumber": "string",
    "peppolAddresses": [
      "string"
    ],
    "address": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "email": "string",
    "phone": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

500application/json

`application/json`

`application/json`

`application/json`