Customers

POST /customers

For relating scan data to customers, you may create a customer record on the Standard Cyborg Platform using an external identifier (external_uid). Any customer metadata must be stored externally. The team to which the customer is attached is determined by the API credentials with which the request is submitted. The returned record contains a uid with which you may refer to the customer within the Standard Cyborg Platform.

Note that lookup by external_uid uses exact string matching.

Endpoint

POST /api/v2/customers

Parameters

Name Description type
customer[external_uid] required External customer identifier string

Request

Route

POST /api/v2/customers

Headers

Accept: application/json
Content-Type: application/json
Access-Token: d828034348d31ca6edd2622c19ef1cf280363728003305ab50002ecba9243e4e$$juFf31sNPythHpZHWJpRXdrlnE0daPDHdbzjsQxPUcfakPIN5MpPe1m3OQ==--D12qzRLzg5kQHkEU--4T8p6fjuMfPkvFBOzEKPYQ==
Api-Key: Z1qScSLLzzovLbcj

Body

{
  "customer": {
    "external_uid": "Customer #123"
  }
}

Response

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "customer": {
    "external_uid": "Customer #123",
    "team_uid": "3oV68aDz",
    "uid": "YLKyFtPp"
  }
}