Upsert Customer

Create or update a customer.

POST

/api/v1/customers

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

TypeScript Definitions

Use the request body type in TypeScript.

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<string>

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

Example"BE"

email?|

The email address of the customer

phone?|

The phone number of the customer

Response Body

`application/json`

curl -X POST "https://example.com/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": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`