Create or Update a Customer

This API endpoint enables you to create or update a customer record for a specified subcompany. If the customer doesn't exist, it'll create a new one and, if it exists (matches your unique ID) then it'll update the customer. You need to provide the subcompany ID and the customer's unique ID in the URL path. The customer details should be included in the JSON body, and the takeover secret must be included in the header.

Create or Update a Customer

PUThttps://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/create-customer/{provided_unique_id}

Path parameters

subcompany_id*Subcompany Id

provided_unique_id*Provided Unique Id

Header parameters

Body

application/json

external_customer_idExternal Customer Id

nameName

locationLocation

emailEmail

phone_numberPhone Number

avatarAvatar

Response

200404422

Successful Response

Body

application/json

id*Id

subcompany_id*Subcompany Id

provided_unique_id*Provided Unique Id

external_customer_id*External Customer Id

stringnull

name*Name

stringnull

location*Location

stringnull

email*Email

stringnull

phone_number*Phone Number

stringnull

avatar*Avatar

stringnull

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/create-customer/{provided_unique_id}', {
    method: 'PUT',
    headers: {
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200422

{
  "id": "text",
  "subcompany_id": "text",
  "provided_unique_id": "text",
  "external_customer_id": "text",
  "name": "text",
  "location": "text",
  "email": "text",
  "phone_number": "text",
  "avatar": "text"
}