Create a customer

Creates a customer.

Endpoint

POST /integration/customer

API allows only 1 customer per company to add, otherwise returns code: company_can_have_only_one_customer

HTTP Request

POST /integration/customer

Customer Object

{
  "id": "dc506b22c7fa",
  "firstName": "John",
  "lastName": "Doe",
  "emailAddress": "[email protected]",
  "cellPhoneNumber": "+11234567890",
  "sourceModifiedDate": "2023-01-04T09:47:57.477Z",
  "companyId": "c506b22c7fad"
}

Request parameters

Name	Description	Required	Type
id	Identifier for the customer	true	string
firstName	First name of the main contact for the customer / company	true	string
lastName	Last name of the main contact for the customer / company	true	string
emailAddress	Email address of the main contact for the customer / company. This email address will be used to send the notifications out	true	string
cellPhoneNumber	Cellphone number of the main contact for the customer / company. This phone number will be used to send the notifications out	true	string
sourceModifiedDate	Date the record was last changed in the accounting service provider	true	datetime
companyId	Optional field to link a customer to a company in time of creation	false	string

Successful response

HTTP 201

{
  "blueTapeId": "fb5637b2e5f3",
  "signUpUrl": "https://www.bluetape.com/signup?id=97bee7a043b58084"
}

Erroneous response

HTTP 409

{
  "code": "409",
  "reason": "Customer already exists."
}

Responses

Code	Description
201	Created, successful operation
400	Invalid request
401	Unauthorized
404	Not found
500	Unexpected error

Examples

curl https://api.bluetape.com/genericBthubService/integration/customer \
  -X POST \
  -H "X-BlueTape-Key: <your-key>" \
  -H "X-Integration-AccountId: <your-account-id>" \
  -H "Content-Type: application/json" \
  -d "@request.json"

import fetch from 'node-fetch';

const customer = { ... };
const url = 'https://api.bluetape.com/genericBthubService/integration/customer';
const options = {
  method: 'POST', 
  headers: {
    'X-BlueTape-Key': '<your-key>',
    'X-Integration-AccountId': '<your-account-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(customer)
};

fetch(url, options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using Flurl.Http;

var content = new Customer() {
  ...
};

var result = await "https://api.bluetape.com/genericBthubService/integration/customer"
  .WithHeader("X-BlueTape-Key", "<your-key>")
  .WithHeader("X-Integration-AccountId", "<your-account-id>")
  .WithHeader("Content-Type", "application/json")
  .PostJsonAsync(content)
  .ReceiveJson<BlueTapeIntegrationResult>();

import requests

url = "https://api.bluetape.com/genericBthubService/integration/customer"

headers = {
    "X-BlueTape-Key": "<your-key>",
    "X-Integration-AccountId": "<your-account-id>",
    "Content-Type": "application/json"
}

data = <your-customer-data>

response = requests.post(url, headers=headers, data=data)

print(response.text)