Customer

Create a customer

Creates a customer

post/api/v1/customers

Request

Base URL
https://api.copperx.dev
Auth
HTTP bearer
TypeScript
https://skmtc.dev/copperx/apis/copperx-api-2/docs/api/v1/customers/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

The name

phonestring

The phone

organizationNamestring

The organization name

customerReferenceIdstring

Customer's reference id

visibilitystring

metadataobject

Customer's metadata

emailstring required

The email

Response

namestring

The name

emailstring

The email

phonestring

The phone

organizationNamestring

The organization name

idstring uuid required

Customer's id

createdAtstring date-time

Customer's created at

updatedAtstring date-time

Customer's updated at

customerReferenceIdstring

Customer's reference id

visibilitystring

metadataobject

Customer's metadata

customerNumberstring required

Customer number assigned by the system

Example response

{
  "id": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "taxIds": {
    "data": [
      {
        "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.