Avalex Customers API — Create, Read, Update, Delete

The /customers resource lets you manage the individuals and organizations that purchase your software. You can create new customer records, look up existing ones by ID, update contact details, and remove customers that are no longer needed. All requests must be authenticated with a JWT Bearer token or HTTP Basic credentials.

Required Permissions

Action	Permission
List / retrieve customers	`customers:read`
Create / update customers	`customers:write`
Delete customers	`customers:delete`

List All Customers

string

required

Bearer <token> or Basic credentials.

Retrieve an array of all customer records in your Avalex account.

curl http://localhost:8080/customers \
  -H "Authorization: Bearer <token>"

Response — 200 OK

[
  {
    "id": "cust_123",
    "name": "Acme Corp",
    "email": "contact@acme.com",
    "socials": {
      "twitter": "@acme",
      "linkedin": "acmecorp"
    },
    "note": "VIP Client",
    "createdAtEpochMillis": 1723140000000
  }
]

Create a Customer

string

required

Bearer <token> or Basic credentials.

string

required

Full name or company name of the customer.

string

required

Primary contact email address.

object

Optional social media handles.

string

Internal note visible only to staff.

Creates a new customer record and returns it with a server-generated ID.

curl -X POST http://localhost:8080/customers \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "contact@acme.com",
    "socials": {
      "twitter": "@acme",
      "linkedin": "acmecorp"
    },
    "note": "VIP Client"
  }'

Response — 201 Created

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "contact@acme.com",
  "socials": {
    "twitter": "@acme",
    "linkedin": "acmecorp"
  },
  "note": "VIP Client",
  "createdAtEpochMillis": 1723140000000
}

Get a Customer by ID

string

required

The unique customer ID (e.g. cust_123).

Returns a single customer record. Responds with 404 Not Found if no customer with that ID exists.

curl http://localhost:8080/customers/cust_123 \
  -H "Authorization: Bearer <token>"

Response — 200 OK

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "contact@acme.com",
  "socials": {
    "twitter": "@acme",
    "linkedin": "acmecorp"
  },
  "note": "VIP Client",
  "createdAtEpochMillis": 1723140000000
}

Update a Customer

string

required

The unique customer ID.

Performs a full replacement of the customer record. You must supply all fields — omitted fields will be cleared. Returns 404 Not Found if the customer does not exist.

This is a full replacement (PUT). If you omit socials or note, those fields will be unset on the stored record. Include all existing values you want to retain.

curl -X PUT http://localhost:8080/customers/cust_123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "new-contact@acme.com",
    "socials": {
      "twitter": "@acme",
      "linkedin": "acmecorp"
    },
    "note": "VIP Client — renewed 2024"
  }'

Response — 200 OK

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "new-contact@acme.com",
  "socials": {
    "twitter": "@acme",
    "linkedin": "acmecorp"
  },
  "note": "VIP Client — renewed 2024",
  "createdAtEpochMillis": 1723140000000
}

Delete a Customer

string

required

The unique customer ID.

Permanently removes the customer record. Returns 204 No Content on success and 404 Not Found if the ID does not exist.

curl -X DELETE http://localhost:8080/customers/cust_123 \
  -H "Authorization: Bearer <token>"

Response — 204 No Content

Customer Schema

The following fields are returned on every Customer object.

Show Customer fields

string

Unique identifier for the customer, assigned by Avalex on creation (e.g. cust_123).

string

Full name or company name of the customer.

string

Primary contact email address for the customer.

string

Twitter / X handle associated with the customer (e.g. @acme).

string

LinkedIn profile slug or company page identifier (e.g. acmecorp).

string

Free-text internal note visible only to staff. Not exposed to the customer.

number

Unix timestamp in milliseconds representing when this customer record was created.

Full Schema Example

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "contact@acme.com",
  "socials": {
    "twitter": "@acme",
    "linkedin": "acmecorp"
  },
  "note": "VIP Client",
  "createdAtEpochMillis": 1723140000000
}

Authentication

License Validation

Resources

Staff & Admin

Audit Logs

Avalex Customers API — Create, Read, Update, Delete

Required Permissions

List All Customers

Create a Customer

Get a Customer by ID

Update a Customer

Delete a Customer

Customer Schema

Full Schema Example

​Required Permissions

​List All Customers

​Create a Customer

​Get a Customer by ID

​Update a Customer

​Delete a Customer

​Customer Schema

​Full Schema Example

Required Permissions

List All Customers

Create a Customer

Get a Customer by ID

Update a Customer

Delete a Customer

Customer Schema

Full Schema Example